README.md 1.51 KB
Newer Older
YIHANG WU's avatar
10.17    
YIHANG WU committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# React Boilerplate
[![ReactJS](https://i.imgur.com/Cka06kf.png)](https://reactjs.org/)
[![Pipeline](https://gitlab.com/MihajloNesic/react-boilerplate/badges/master/build.svg)](https://gitlab.com/MihajloNesic/react-boilerplate/commits/master)
[![create-react-app](https://badge.fury.io/js/create-react-app.svg)](https://facebook.github.io/create-react-app/)

Simple React boilerplate for GitLab Pages<br>
#### [LIVE DEMO](https://mihajlonesic.gitlab.io/react-boilerplate/)

##### Other demos
[React Todo List](https://mihajlonesic.gitlab.io/react-todo-list/)<br>
[React Markdown Editor](https://mihajlonesic.gitlab.io/react-markdown/)

## Getting Started

Clone the boilerplate if you haven't downloaded it
```
git clone https://gitlab.com/MihajloNesic/react-boilerplate.git
```

Navigate to the boilerplate project folder
```
cd react-boilerplate
```

Run the setup to get everything up and running
```
npm install
```

Inside **package.json**, change the *homepage* to your own URL
```
"homepage": "http://USERNAME.gitlab.io/PROJECT"
```

And start the development server
```
npm start
```

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

### Alteriative

**Fork** this project

Inside **package.json**, change the *homepage* to your own URL
```
"homepage": "http://USERNAME.gitlab.io/PROJECT"
```

## More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).