WorldClassProgrammers / Government-APIs

Government site APIs for vaccine booking system (SP Course)

Government APIs

Deployed APIs

Installation

Required Dependency

This project runs on Python 3.6 or higher. It also uses virtualenv to manage virtual environments.

Other Required Software Packages

These additional packages need to be installed too. All of them are listed in the requirements.txt.

Name	Currently use version	Notes
Flask	2.0	A simple framework for building complex web applications.
Flask-Cors	3.0.10	A Flask extension for handling Cross Origin Resource Sharing (CORS), making cross-origin AJAX possible.
Flask-SQLAlchemy	2.5.1	Adds SQLAlchemy support to your Flask application.
gunicorn	20.1.0	WSGI HTTP Server for UNIX.
psycopg2	2.9.1	Python-PostgreSQL Database Adapter.
psycopg2-binary	2.9.1	Python-PostgreSQL Database Adapter.
SQLAlchemy	1.4.25	Database Abstraction Library.
flasgger	0.9.5	Auto-API-Document Generator.
flask-swagger	0.2.14	Extract swagger specs from your flask project.
Flask-JWT-Extended	4.3.1	JWT Authentication
Werkzeug	2.0.2	A comprehensive WSGI web application library.

Create local postgres database named 'government'

Create .env file use your postgres's username instead of <USERNAME> and your password instead of <PASSWORD>

DEBUG=True
SQLALCHEMY_DATABASE_URI=postgresql://<USERNAME>:<PASSWORD>@localhost/government

Create a new virtual environment (first time only)

virtualenv env

Activate the virtual environment

On Linux or MacOs:

. env/bin/activate

On Windows:

env\Scripts\activate

Install the required packages (first time only)

pip install -r requirements.txt

Run app.py

APIs

APIs Document

Basic CMD

# install dependencies
$ pipenv shell
# install pip to pipFile
$ pipenv install <PACKAGE_NAME>
# update Pipfile.lock
$ pipenv lock

# create requirements.txt
$ pip freeze > requirements.txt

set up database

$ cd app
$ python

> from models import db

# reset database
> db.drop_all()

# initial database
> db.create_all()