Skip to content

RESTful Web API that powers the Teacher Supply Donation Web Application

License

Notifications You must be signed in to change notification settings

CS467-Fall-2022-Capstone/donation-web-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Web API for Teacher Supply Donation Web Application

Get Started

After cloning or forking the project, install the packages for the project

npm install

Set the environment variables in the .env file

PORT=3000  # For local development
MONGODB_URI=mongodb+srv://<username>:<password>@cluster1.hmltzxa.mongodb.net/DonationDB?retryWrites=true&w=majority
JWT_SECRET=<Your Secret>
JWT_ALGO=<Your Algo>
TSD_EMAIL_ADDRESS=<Email address, must be a GMail address>
TSD_EMAIL_PASS=<Your email account password>

Replace <username> and <password> in the MONGODB_URI string with your database credentials. If you want to use a local version of MongoDB then replaec the string with mongodb://localhost:27017/<dbname>

Run the server with nodemon

npm start

Testing

The unit and integration tests were written with mocha, chai, and supertest.

To run the test suite

npm test

About

RESTful Web API that powers the Teacher Supply Donation Web Application

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published