Skip to content

lorezi/stackoverflow

Repository files navigation

Stackoverflow Documentation

The stackoverflow task is basic implementation of Stackoverflow.

Documentation

API Documentation here


API built with Node + Express + MongoDB + Mongoose + Socket.io + Jest.

Written in TypeScript.


Start Development

Kindly clone the repo ``

Setup

Create a .env file in the root directory and add the following properties

PORT=?
DATABASE=?
JWT_SECRET=?
JWT_EXPIRES_IN=?
JWT_COOKIE_EXPIRES_IN=?

Installation

To install the necessary packages, in your root folder directory kindly run

# Install dependencies
$ yarn install

# Start the app
$ yarn start

# Run test
$ yarn test

API Endpoints

Base Url - http://localhost:{PORT}/

User

  • POST /users/signup
  • POST /users/login
  • GET /users/logout

Question

  • GET /questions
  • GET /questions/:id
  • PATCH /questions/:id/up-vote
  • PATCH /questions/:id/down-vote
  • POST /questions/:id/reply
  • POST /questions/:id/subscribe

🎩 Author

  • Lawrence 😁😁😁