Skip to content

README.md

Latest commit

 

History

History
66 lines (51 loc) · 2.35 KB

README.md

File metadata and controls

66 lines (51 loc) · 2.35 KB

Build Status Maintainability Test Coverage Run in Postman

Api Link

https://airtech-api-app.herokuapp.com/

Airtech

This project automates the flight booking system

Getting Started

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

Prerequisites

To install this project you need the following framework and tools

- Python3
- Postgres
- Memcached

Installing

These Steps would help you install the project dependent packages and run the application. The project has two sections FrontEnd and BackEnd, the instructions here is structure to setup both section interdependently.

Primary steps

  • Clone the repository and CD into the repository directory
  • Ensure that you have created a database for this project
  • Create a .env file
  • Update the new .env file with required data

How to Start the backend

  • create and activate a virtual environment. Here is an example using Pipenv: run pipenv install
  • Start shell pipenv shell
  • Run migration python manage.py migrate
  • Start the app via Django python manage.py runserver
  • create a database in postgres and make the connection via the environment variable

To run locally

  • Start the app via Django python manage.py runserver
  • Open a HTTP client (e.g. Postman)...:
    • Make a POST request to the endpoint v1/api/login with Headers:
    Authorization: {jwt-token}
  • Get and use the token value in the response object for all subsequent requests. Under the Authorization menu,
    • TYPE is Bearer Token
    • Token is {token value}

To run tests locally

  • pytest

Admin user login

Built with

  1. Django
  2. Djangorestframework
  3. Postgres

Contributors

  • Onengiye Richard (klevamane)

Author

  • Onengiye Richard (klevamane)