This is just a simple backend to build on later on.
Currently has 2 db connections of Redis and Postgres.
For the project there was no ORM used for Postgres, but can be integrated some ORM like Sequelize or TypeORM for commercial needs.
- Download the code
- Copy
.env.example
file as.env
cp .env.example .env
- Edit the
.env
file correspondingly - Install all packages and dev dependencies
npm install
Additionally you could run
npm run prepare
to prepare husky hooks
- Run the server in dev mode
npm run dev
To run on production, use
start
insteaddev
There is an example of User controller with routing, service and repository logic to look at and copy from.
- Setup Docker for Running the project as a container
- Add ORM option for Postgres (maybe in another branch)
- Add test via Jest