andrewhingah/stackoverflow-lite

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

StackOverflow-Lite

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

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purpose

Prerequisites

You need to have the following installed.

• Git
• Postman
• Python 3.6
• Pip

Installing

1. Clone the repository git clone https://github.com/andrewhingah/stackoverflow-lite.git

2. Change directory cd stackoverflow-lite

3. Checkout to developAPI branch git checkout developAPI

4. To test API locally, set up a virtual environment in the base project folder python -m venv venv

5. Activate the virtual environment venv\Scripts\activate

6. Install dependecies pip install -r requirements.txt

7. Run tests pytest or nosetests --exe --with-coverage --cover-package=api

8. Test the endpoints on postman

   For instance to post a new question you send a request to http://127.0.0.1:5000/api/v1/questions

   A sample post question request should be as shown below

    {
    	"question":"What is an API?"
    }
   

Built with

• Python 3.6
• Flask

Contributing

1. Fork it from https://github.com/andrewhingah/stackoverflow-lite.git/fork

2. Create your feature branch git branch somefeature git checkout somefeature

3. Commit your changes git commit "Add some feature"

4. Push to the branch git push origin somefeature

5. Create a new pull request

Author(s)

Andrew Hinga [email protected]