Skip to content

arthurarty/stack-over-flow-lite-api

Repository files navigation

Build Status Coverage Status Maintainability

stack-over-flow-lite-api

Description

StackOverFLow-lite is an api through which users can login, view all questions with their respective answers, post questions and get answers from other users.

Link to application to api documentation:

https://stackarty.herokuapp.com/

Link to demo on heroku application

https://stackarty.herokuapp.com

Requirements

  • Python 3.5 or greater : Python is interpreted high-level programming language for general-purpose programming.
  • FLask : Flask is a micro web framework written in Python.
  • Flask-JWT-Extended : A flask extension that makes it easy to protect endpoints using jwt tokens.
  • Postgres Sql : An open source relational database management system ( DBMS )
  • psycopg2 : PostgreSQL adapter for the Python programming language.

Installation

$git clone https://github.com/arthurarty/stack-over-flow-lite-api
$cd stack-over-flow-lite-api
$python database_setup.py
$python run.py

Project Overview

Endpoint Functionality Note
POST /auth/signup Register a user
POST /auth/login Login a user
GET /questions Fetch all questions
GET /questions/ Fetch a specific question This should come with the all answers provided so far for the question.
POST /questions Post a question
Delete /questions/ Delete a question This endpoint should be available to the author’s author.
POST /questions//answers Post an answer to a question
PUT /questions//answers/ Mark an answer as accepted or update an answer. This endpoint should be available to only the answer author and question author. The answer author calls the route to update answer while the question author calls the route to accept answer.

About

Challenge 3 of Andela Challenge.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published