/stackoveerflow-clone

Api clone of stackoverflow

Primary LanguageJavaScriptMIT LicenseMIT

stackoveerflow-clone

Api clone of stackoverflow

Prerequisites

Technologies

Features

  • User authentication signup and signin with JWT
  • Create Question
  • Read one question
  • Read all Questions
  • Answer a Question
  • View one answer to a question
  • View all answers to a question
  • upvote/downvote questions
  • Search through Users, Questions and Answers
  • Pagination for list of questions and answers

Install Project

  • clone project on local machine
  • navigate into local repository by running cd way-farer-api
  • create Mongodb database
  • create a .env file in root directory and fill it up using example in .env.example
  • run npm install
  • run npm start

Test

API test is written with mocha and supertest.

  • clone project on local machine
  • navigate into local repository by running cd stackoveerflow-clone
  • create mongodb database
  • create a .env file in root directory and fill it up using example in .env.example
  • run npm install
  • run npm run test

TODO/WIP

  • Email Notifications with sendgrid API

How to contribute

  • The project is open for contribution. You can start by forking this project repo. If you have improvements you want to add, feel free to do so and create a PR against develop branch

Documentation

The API documentation for this project can be found here: API Documentation

License

MIT