This is the API of a platform for people to share their college exams anonymously.
NodeJs
Express
Jest
Supertest
This api is deployed on Heroku, you can visit it by accessing this url.
This route just returns the http 200 OK status code and is used to check if the API is running.
Returns the list of registered teachers.
Returns the list of registered subjects.
Returns the list of registered exams.
Returns the list of registered exams categories.
Receives a JSON containing the exam name, link, teacher, subject and category.
You must have installed node and npm.
First run npm i
to install all dependencies.
Use the sql script to create your database structure and populate it with the basic data (SQL dump here).
And then create a .env file following as an example the .env.example file, setting the environment variables accordingly. with data from your database (.env.example file here).
In the project directory, you can run:
Runs the app in the development mode.
Open the HOST:PORT that you that you set up in you env file to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the sequencial mode.7
Warning
You need to create a .env.test file following the same .env.example file to run this command.
Launches the test runner in the interactive watch mode.
Warning
You need to create a .env.test file following the same .env.example file to run this command.
If you want to run any of the above commands on Windows, just add :windows
to the end of any of them.