https://github.com/prathameshdhande22/dumpapi-flask-restful

DumpAPI is a Flask RESTful API with JWT token authentication, storing department and employee data in a free cloud PostgreSQL database with password hashing for security.
https://github.com/prathameshdhande22/dumpapi-flask-restful

api api-rest flask flask-restful flask-sqlalchemy flaskrestful orm orm-framework orm-library postman postrgresql python3 sqlalchemy yugabytedb

Last synced: 3 months ago
JSON representation

DumpAPI is a Flask RESTful API with JWT token authentication, storing department and employee data in a free cloud PostgreSQL database with password hashing for security.

• Host: GitHub
• URL: https://github.com/prathameshdhande22/dumpapi-flask-restful
• Owner: PrathameshDhande22
• License: mit
• Created: 2023-07-02T11:31:05.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-03T05:49:17.000Z (over 2 years ago)
• Last Synced: 2025-03-04T08:31:54.214Z (7 months ago)
• Topics: api, api-rest, flask, flask-restful, flask-sqlalchemy, flaskrestful, orm, orm-framework, orm-library, postman, postrgresql, python3, sqlalchemy, yugabytedb
• Language: Python
• Homepage: https://dumpapi-flask-api.onrender.com/
• Size: 12.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DumpAPI

[![Made with Python](https://img.shields.io/badge/Made%20with-Python-blue.svg)](https://www.python.org/)

DumpAPI is a Flask-Restful API that contains data of departments and their employees. The API utilizes token generation with JWT (JSON Web Tokens) for secure access. All the data is stored in a cloud database provided by Yugabyte, which offers a free PostgreSQL database service. The passwords are hashed and stored in the database for enhanced security.

## Docs :

Read Docs Generated by Postman : [Read Docs](https://documenter.getpostman.com/view/28292111/2s93zCYLNW) 

## Usage

To use the DumpAPI in your system, follow the steps below:

1. Create a virtual environment for the project.

2. Install all the required dependencies using  `pip install -r requirements.txt`.

3. Add your `.env` file in the `DumpAPI` folder, containing the following data:

```

DATABASE_YUGA="your database sqlalchemy uri"

ENCRYPT_KEY="your key" (for encrypting the passwords)

JWT_KEY="your key" (for encrypting the JWT token)

```

4. Run the `run.py` file to start the API.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.

## Attribution

![Made with Python](https://img.shields.io/badge/Made%20with-Python-blue.svg)

## Author : Prathamesh Dhande