Steps to run this project:
N/B: Make sure you have node and postgres installed
- Run
npm i
to install dependencies - Setup database settings inside an
.env
file, see.env.sample
for inspiration - Run
npm start
to start server (without hot reload). N/B: (runs compiled js) - Run
npm run server
to start server (without hot reload). N/B: (runs typescript withts-node
) - Run
npm run dev
to use hot reload on local environment. N/B: (runs typescript withts-node
) - Run
npm run tsoa_build_and_run
to build routes field and swagger files also start server (needed after making changes to models, services or controllers)
Run this below script if you ever encounter some funny Error : Cannot find module errors..
rm -rf node_modules package-lock.json && npm install && npm start
Documentation: localhost:3000/docs/
Admin: localhost:3000/admin/