Neivanny1 / bookmarker_api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BookMarker API

Purpose

I built this project with only one goal in mind understand authentication with JWT and API documentation with Swagger

Tech Stack

BookMarker API is built using a combination of Python, JWT extended, swagger and Flask framework with postgresql database.

  • Python: Backend logic.
  • JWT extended: Token authentication.
  • Swagger: Documentation.
  • Flask: Powers the backend logic and facilitates server-side operations.
  • Postgres: Serves as the database management system for storing application data.

Requirements to run the project

Kindly make sure you have following before proceeding to installation.

  • 1. Python
  • 2. Text editor, VS code recommended
  • 3. Git
  • 5. Pip

Installation

  • ubuntu@user: git clone https://github.com/Neivanny1/bookmarker_api.git
  • ubuntu@user: cd bookmarker_api
  • ubuntu@user: create database and replace url QLALCHEMY_DB_URI in .flaskenv
  • ubuntu@user: python3 -m venv venv
  • ubuntu@user: source venv/bin/activate
  • ubuntu@user: pip install -r requirements
  • ubuntu@user: flask shell ---> enters in flask shell
  • ubuntu@user: from src import app
  • ubuntu@user: db.create_all() ---> creates all tables in models to db
  • ubuntu@user: flask run

Visit 127.0.0.1:5000 on your browser

Contribution

Having issues with code or fixess to add feel free to fork the project and create a PR will review soon as recieved

AUTHOR

Eric MWakazi

Swagger Documentation page

Home



Description of the embedded content



Endpoints



Description of the embedded content



About

License:MIT License


Languages

Language:Python 98.4%Language:Shell 1.3%Language:Procfile 0.2%