Steps to run this project locally:
- Run
npm i
command. - Add your env variables to
.env
file, look at.env.sample
file for reference. - Run
npm run build
to compile the project. - Run
npm lint
to lint the project. - Run
npm test
to run the test. - Run
npm run build:watch
to compile the project in watch mode. - Run
npm run dev
to run the server in watch mode. - Run
npm start
command to start the server.
You need to have a database instance to run this project as it uses mongodb to connect to a database, you can also run the server by running docker-compose up
which will create a docker container for MongoDB then run the instance in a container
Built with TypeScript, MongoDB andExpress.
Built with ❤️ by @bkoiki950