| 1 | # Fullstack System
|
| 2 | > A build and development system for creating Client+Server applications with Socket.IO, React, and
|
| 3 | > Express.
|
| 4 |
|
| 5 | This module provides a setup for creating web applications with a backend server and front end client. Out of the box, you
|
| 6 | can use Socket.IO, React, and Express, all with hot reloading, but you can use other libraries like Vue or Angular.
|
| 7 |
|
| 8 | This framework might not be the best thing to use since the Api is not documented much, and I change the default settings
|
| 9 | (to improve them) a lot, and I usually add features only when I need them for my own projects.
|
| 10 |
|
| 11 | ## Create a new Project
|
| 12 | ```
|
| 13 | # Create a new project
|
| 14 | npx fullstack-system new my-app
|
| 15 |
|
| 16 | # NPM Modules are automatically installed, so you can
|
| 17 | # start working right away.
|
| 18 | cd my-app
|
| 19 | npm start
|
| 20 | ```
|
| 21 |
|
| 22 | ## Documentation
|
| 23 | You need two entry files in your project, one at `./src/server/index.js` and one at `./src/client/index.js`. Right now you cannot have these in other places.
|
| 24 |
|
| 25 | ### Files
|
| 26 | - `index.html` index.html template
|
| 27 | - `src/client/index.js` Client Entry File
|
| 28 | - `src/server/index.js` Server Entry File
|
| 29 | - `src/static` Extra static resources mounted at root of website.
|
| 30 | - `webpack.config.js` Webpack extension configuration.
|
| 31 | - `webpack.client.config.js` Webpack extension configuration (only on client).
|
| 32 | - `webpack.server.config.js` Webpack extension configuration (only on server).
|
| 33 | - `babel.config.js` Babel config extension.
|