/naijapoll

Primary LanguageJavaScript

9jaPoll API

The server for Zuri Internship Project 100.

About 9jaPoll

The technologies we will be using for the project include but not limited to the following:

  • Node.js
  • Express
  • MongoDB

Description

Election season is fast appproaching and 9jaPoll can be the number one stop websites where everyone can come and check the profiles of those politicians contesting for executive offices or any key ranking posts in the country.

Some of the features of the app v1 are:

  • REST API Design
  • Mongoose ODM
  • JWT Authentication

Prerequisites

  • Node.js
  • MongoDB database

Contribution Guide

  1. Fork the repo from Github

  2. Clone the repo into your local machine

  3. Create a new branch on your local machine git checkout -b branch-name

  4. Run git branch to make sure you are on the branch and not the main (or master as the case may be)

  5. Commit the changes made to the branch by running git commit -m message

  6. Push to the forked repo by running git push

  7. Head back to the original repo you forked from, and you will see a prompt to open a new Pull Request from the branch you just pushed to

  8. Click Compare & pull request, add a description describing the changes made, and then open the PR

  9. Wait for the PM to review and merge

Installation Guide

Create your .env file

run npm install to install the packages

run npm run dev or any start script specified to start up the server

MongoDB cloud (atlas) will be used for our DB

MMake sure you test your API with Postman, the VS Code extension, Thunder Client or any other preferred API tester.