Tech Stacks
- NodeJS
- ExpressJS
- Prisma ORM
- PostgreSQL [Preferrable]
How to run the project
- Copy the .env.example file to .env
- Update the values in the .env file
- Copy the config-example.json file to config.json
- Update the values in the config.json file
- Run
npm install
to install all the dependencies - Run
npm run dbMigrate
to apply all the migrations to database - Run
npm run dev
to start the server
API Documentation
Visit this link to explore all the APIs. https://www.postman.com/winter-shadow-563181/workspace/f3c668ad-9d3d-4374-9f02-69d88c7ec4a6/collection/11590503-42c87cda-ea0a-42b9-bafc-0d0c46757d6f?action=share&creator=11590503
Before using the API schema, make sure to create a variable named
entrypoint
in postman and assign value of server. For example,http://localhost:3000
How to contribute
Join us on slack and lets talk in backend
channel.
Slack Invitation Link : https://join.slack.com/t/portio-in/shared_invite/zt-1medvyxwy-1HHv2gqCzGwvBRtToQ9KMA
Will update tasks list soon