https://github.com/bongomin/andela-todo-api-practice

creating endpoints , routes ,testing and intergrating the api with travis ci and pivortal tracker
https://github.com/bongomin/andela-todo-api-practice

Last synced: 2 days ago
JSON representation

creating endpoints , routes ,testing and intergrating the api with travis ci and pivortal tracker

• Host: GitHub
• URL: https://github.com/bongomin/andela-todo-api-practice
• Owner: bongomin
• Created: 2019-02-17T07:56:20.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-22T09:13:22.000Z (almost 6 years ago)
• Last Synced: 2024-11-10T16:12:35.596Z (2 months ago)
• Language: Python
• Homepage:
• Size: 10.3 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/bongomin/ToDos.svg?token=PtPAqn4oT3tB9pzFjhH4&branch=develop)](https://travis-ci.com/bongomin/ToDos)

[![Coverage Status](https://coveralls.io/repos/github/bongomin/ToDos/badge.svg?branch=master)](https://coveralls.io/github/bongomin/ToDos?branch=master)

## Installation Instructions for the app:

1. Install Flask using `pip install flask`

2. Clone the app using `git clone https://github.com/JSnakegitHub/Challenge-3.git`

## Getting Started With Tests:

### For Python 2:

1. `pip install pytest`

2. `pip install coverage report`

3. `pip install pytest-cov`

4. `pip install pytest-xdist`

### For Python 3:

1. `pip3 install pytest`

2. `pip3 install coverage report`

3. `pip3 install pytest-cov`

4. `pip3 install pytest-xdist`

## Running the tests on a virtual environment

### For python 2:

1. `pip install -U virtualenv`

2. `python -m virtualenv venv`

3. `source venv/bin/activate` # in Windows -> venv\Scripts\activate.bat

4. `pip install pytest`

### For Python 3:

1. `pip3 install -U virtualenv`

2. `python3 -m virtualenv venv`

3. `source venv/bin/activate` # in Windows -> venv\Scripts\activate.bat

4. `pip install pytest`

### For Python 3.6+:

2. `python3 -m venv venv`

3. `source venv/bin/activate` # in Windows -> venv\Scripts\activate.bat

4. `pip install pytest`

### What The Tests Are Testing:

1. If the required endpoints are rendered.

2. If the requests are being sent in the right format (JSON-JavaScript Object Notation).

3. If Validations are being respected

## Testing the App Locally.

1. [Postman](https://www.getpostman.com/) should be used to test the application locally

2. Move to the project directory locally

3. Once you are in the project's root directory, run the command `python run.py`.

4. At this point the server should be running.

5. The application is set to run on port 8080