This is a short documentation on how to set up the project on your local machine
- Database: MongoDB
- Payment Gateway: Paystack
- Download/Clone the repository into your working directory
- Run
npm install
on your working directory to install all dependencies - Create a
.env
file and follow or copy the contents ofenv.example
into your.env
file to set up your environment variables - Run
nodemon
ornpm start
to start your server (ensure you have completed setting up your enviroment variables) - Open your browser and type in your project host and port number followed by
/api-docs
. Examplehttp://localhost:3000/api-docs
to access a complete documentation on all endpoints.