- Run
git clone https://github.com/jahdevelops/Jobo_API
to download the repo. - Run
npm ci
to install the required npm packages.
After installing the packages, create a '.env' file in the root directory.
These variables are required in the '.env' file created above, use any value of you choice.
PORT
NODE_ENV
DB_URL
USER_JWT_SECRET
USER_COOKIE_SECRET
.
The DB_URL
variable represents a URI to a mongoDB database cluster.
After creating the reqired env variables, type npm run dev
to run the project in development mode.
A list of all available APIs and documentation can be found here
Upon successfull login, the server stores a secured cookie on the client. This cookie will be used to authencate and authorise the user when making requests to the protected routes.