Skip to content

Latest commit

 

History

History
86 lines (70 loc) · 2 KB

README.md

File metadata and controls

86 lines (70 loc) · 2 KB
Raw

StackOverFlow_lite Build Status Coverage Status

StackOverflow-lite is a platform where people can ask questions and provide answers

Usage

  • Home page
  • Create an account
  • Login into your account
  • Post a question
  • Fetch all questions
  • Fetch a single question
  • Edit a specific question
  • Delete a specific question
  • Post an answer to a question

Prerequisities

  • Python 3.6 version

Installation

Downlaod / clone the project to your local computer by:

  • Download the zip file of this repository.
  • Unzip it and navigate into the StackOverflow-lite directory.

Virtual environment

Create a virtual environment

$ virtualenv venv

Activate the environment

$ venv/bin/activate

Dependencies

Install package requirements to your environment

$ pip install -r requirements.txt

Env

Create a.env file in your StackOverflow-lite root directory and add:

  • $ venv/bin/activate

  • $ export FLASK_APP="run.py"

  • $ export SECRET="any-character-or-STRING-YOU-PREFER"

  • $ export APP_SETTINGS="development"

Testing

To set up testing environment

  • $ pip install nose

  • $ pip install coverage

Testing API endpoints

Test Endpoints HTTP VERBS
Post a question /api/v1/questions POST
View all question /api/v1/questions GET
Get single question /api/v1/questions/ GET
Post an answer to a question /api/v1/questions//answers POST

Resources

The API is hosted on Heroku

Authors

Dennis rotich Belio

Acknowledgement

Andela Bootcamp - cohort 31