https://github.com/ampaire/api
this is a repository for creating code for creating Api endpoints.
https://github.com/ampaire/api
Last synced: 2 months ago
JSON representation
this is a repository for creating code for creating Api endpoints.
- Host: GitHub
- URL: https://github.com/ampaire/api
- Owner: ampaire
- Created: 2018-09-21T16:10:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-09T07:22:33.000Z (over 6 years ago)
- Last Synced: 2025-02-07T21:45:22.708Z (4 months ago)
- Language: Python
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/ampaire/Api)
# Api
this is a repository for creating code for creating Api endpoints.
# project build
The purpose of this project was to create Api endpoints for entries data structure. The endpoints were tested in postman.
The required endpoints were for:
-get all entries
-get one entry
-add an entry
-delete an entry
-update/modify an entry
# Required tools
-Server side Framework:
-Linting Library:
-Style Guide:
-Testing Framework:
# Procedure
Before doing anything you first open the folder where you are going to work in the text editor
*To work on the project you first install a virtual environment by running
$pip install virtualenv
*Later create the virtual environment by running the command in the terminal
$virtualenv venv
*To activate the virtualenv you need to run this command in the terminal for linux users
$source venv/bin/activate
*Install flask by running the command below to install the flask module
$pip install --user flask
*install all the other require tools (pylint,auto pep8, pytest) using the command
$pip install
*Install Postman
The endpoints (in the app folder) were created in independent files each on its own github branch. The github branches were later merged to develop. Each feature has its own test framework in the tests folder.
Postman was used to test the endpoints for functionality