You can test the API demo hosted at https://shiftk3yapi.herokuapp.com in Postman
##Usage
| EndPoint | Functionality | Public Access |
|---|---|---|
POST /auth/login |
Logs a user in | TRUE |
POST /auth/register |
Register a user | TRUE |
POST /companies/ |
Create a new company | TRUE |
GET /companies/ |
List all the created companies | TRUE |
GET /users/ |
List all the created users | FALSE |
GET /users/\<id> |
Get a specific user | FALSE |
GET /companies/\<id> |
Get single company | TRUE |
DELETE /companies/\<id> |
Delete this single company | TRUE |
GET /companies?q=\<company_name> |
Search for companies with the same name as that passed in company_name | TRUE |
- Signup and login User
- Create companies
- Python 3.3^
- Flask
- PostGres
- Clone the application: git clone git@github.com:Enkya/ims_beta.git
- cd into the ims-api:
cd ims_beta - Run
python install -r requirements.txt - Create database
- Initialize, migrate, and upgrade the database:
python manage.py db init python manage.py db migrate python manage.py db upgrade - The above command downloads all the dependencies needed for the project
- Run the server
python run.py - You can now access the api from 127.0.0.1:5000/api/v1
- To test, run the following command:
coverage run --source app run_tests.py - View the test coverage with:
coverage report
This project is licensed under the terms of the MIT license.