2021-08-30 21:08:27 +00:00
|
|
|
# noded/backend
|
|
|
|
|
|
|
|
|
|
## Requirements to develop
|
|
|
|
|
- Node.js 14.x
|
|
|
|
|
- MongoDB 4.x
|
2021-08-30 21:09:13 +00:00
|
|
|
- Yarn package manager (version 1.x)
|
2021-08-30 21:08:27 +00:00
|
|
|
|
|
|
|
|
## Setting up develop
|
|
|
|
|
- Clone this repo
|
2021-08-30 21:09:13 +00:00
|
|
|
- Run `yarn install`
|
2021-08-30 21:08:27 +00:00
|
|
|
- Copy `example.env` to `.env`
|
|
|
|
|
- Edit `.env`
|
|
|
|
|
- Change `LOGGING_LEVEL` to `7`
|
|
|
|
|
- Change database information, if necessary
|
|
|
|
|
- Change `ENVIRONMENT` to `development`
|
|
|
|
|
- Change `UPLOAD_DEFAULT_STORE` to `flitter`
|
|
|
|
|
- You can leave this as `s3` if you specify an S3-compatible API and credentials.
|
|
|
|
|
- Make sure Flitter can start using `./flitter test`
|
|
|
|
|
|
|
|
|
|
## Basics
|
|
|
|
|
- Run `node index.js` to start the main server.
|
|
|
|
|
- I like to use `nodemon` to auto-reload when files change.
|
|
|
|
|
- To access the shell for debugging & testing, run:
|
|
|
|
|
- `node --experimental-repl-await flitter shell`
|
2020-02-08 01:50:10 +00:00
|
|
|
|
