-
Notifications
You must be signed in to change notification settings - Fork 0
/
default_doc
147 lines (90 loc) · 4.69 KB
/
default_doc
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# ethervote
Que fa cada carpeta:
- build/ -> contractes compilats
- contracts/ -> contractes sense compilar (.sol)
- dist/ -> es on estara el projecte "compilat", falta afegir els smart contracts
- frontend/ -> carpeta amb el frontend amb react
- migrations/ -> carpeta de truffle
- node_modules/ -> moduls de npm del projecte
- scripts/ -> no estic segur
- server/ -> backend
- test/ -> tests del truffle
Install the dependencies in the local node_modules folder. By default, npm install will install all modules listed as dependencies in package.json.
```
npm install
```
Finally, you can start your app:
```
npm start
```
Build:
```
npm build
```
# create-express-react
Get started with [create-react-app](https://github.com/facebookincubator/create-react-app) and your own [express](https://expressjs.com/) server for development and production.
## Features
- CLI to generate project structure
- Fully ES6 support
- Pre-written npm scripts to help development, testing, linting, building and deployment process
- [Eslint](https://eslint.org/) for both frontend and backend
- [Jest](https://facebook.github.io/jest/) for both frontend and backend
## Prerequisites
- [Node.js](https://nodejs.org/en/), from v0.12.x to the latest version. Using any version of v6.x.x or above is preferred.
## Installing
First of all, you should install `create-express-react` via npm as a global package, this is the CLI to generate the template for you to get started.
```
npm install create-express-react -g
```
Once you have `create-express-react`, then run it to create the template. The command below will generate a folder named `myApp` in `Desktop`.
```
cd ~/Desktop
create-express-react myApp
```
Then you need to grab `create-react-app` by running:
```
cd ~/myApp
npm install
npm run setup
```
Finally, you can start your app:
```
npm start
```
## Scripts
There are a lot of pre-written npm scripts to help you speed up the development and deployment process.
- `npm run setup`
Using official `create-react-app` to generate a folder `root/frontend` for all frontend development. Also adding the proxy setting in `root/frontend/package.json` to pass request to express server.
- `npm run start`
Concurrently starting webpack-dev-server for react running on port `3000`, and express backend server on port `4000`. HOC will be enabled for all react related code and also the server will be restarted by [nodemon](https://github.com/remy/nodemon) if there is any change made for the backend code.
- `npm run test-server`
Running server tests via Jest, which are in `root/server/__test__`
- `npm run test-react`
Running react tests via Jest. There is no test file by default, you may create a folder `/root/frontend/__test__` and put all test files there.
- `npm run lint`
Run ESLint on all backend code. The config files can be found in `root/.eslintrc` and `root/.eslintignore`. __Please note that the linting for react will be auto-enabled when you run `npm run start`__
- `npm run build`
Build all the server side code into `root/dist`, then build react and move all built files (index.html, javascript, css, images, etc.) to `root/dist/public` for production
- `npm run deploy`
Deploy the server via pm2, you can find the config file in `root/deploy.json`.
__There are also some helper npm scripts, see more details in `root/package.json`.__
## Communication
### Dev
For Development, the webpack-dev-server is running on port 3000 serving react app, and the backend express server is running on port 4000. All of the requests sent by frontend app will be passed to express server via proxy.
Web App <--- Webpack-dev-server <---> Proxy <---> Express Server
### Production
For Production, all the frontend code will be compiled and moved into a static directory inside express server. Now there is just one express server running, which is serving both the frontend app and backend endpoints.
Endpoints <--- Express Server ---> Web App
## Project Structure
TBD
## TODO
- Should we put some of the common used react libraries into `root/frontend`?
- Need to discuss the details about how to stucture express code.
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Haochuan Liu** - *Initial work* - [_haochuan](https://haochuan.io)
## License
This project is licensed under the MIT License.