This system is built using a full javascript stack. It requires a mongo databse
Note: This assumes a mongo database is running
yarn- This install all dependencies to run the software- Create a dotenv, or set environment variables to match any required configuration settings. Common Settings include, setting a mongo URI, and port number.
- To build for production, run
yarn run build - The built files will be outputted to ./build/ - If moving the files however, be aware that node_modules is required for the server to run.
- To start production, in this folder, run
yarn run start
This repository assumes you have the following applications
- Yarn
- Node
- MongoDB
| Environment Variable | Default Value |
|---|---|
| MONGO_URL | mongodb://localhost:27017/scriptum |
| PORT | 3000 |
npm run dev React HMR will be run so as you edit react components they will update in real time.
If you want to build production, run npm run build then npm start will start the production environment.
To develop, follow configuration.
Run with yarn run dev