https://github.com/jespy666/restful-flask

Repository for a RESTful Application in Flask (Technical Specification)
https://github.com/jespy666/restful-flask

alembic docker docker-compose flask flask-api flask-restful mysql sqlalchemy sqlalchemy-session sqlite unittest

Last synced: 4 months ago
JSON representation

Repository for a RESTful Application in Flask (Technical Specification)

• Host: GitHub
• URL: https://github.com/jespy666/restful-flask
• Owner: jespy666
• License: mit
• Created: 2024-05-22T08:40:37.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-27T09:37:14.000Z (about 1 year ago)
• Last Synced: 2025-01-20T17:32:17.075Z (6 months ago)
• Topics: alembic, docker, docker-compose, flask, flask-api, flask-restful, mysql, sqlalchemy, sqlalchemy-session, sqlite, unittest
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## RESTful-flask

A simple RESTful-api in Flask representing interaction with a todo list (CRUD)

### Stack  

![Static Badge](https://img.shields.io/badge/Flask-3.0.3-blue?style=for-the-badge)

![Static Badge](https://img.shields.io/badge/Flask%20RESTful-0.3.10-purple?style=for-the-badge)  

![Static Badge](https://img.shields.io/badge/SQLAlchemy-2.0.30-green?style=for-the-badge)

![Static Badge](https://img.shields.io/badge/Alembic-1.13.1-red?style=for-the-badge)  

### How to run

* clone repo `git clone https://github.com/jespy666/RESTful-flask.git`

* go to project dir `cd RESTful-flask`

* create virtual env `python3 -m venv venv`

* activate venv `source venv/bin/activate`

* create and fill .env `touch .env` (see .env.example)

#### By CLI:

* install dependencies `make install`

* apply migrations `make migrate`

* run api `make api`

#### By Docker

* setup ENV in `.env` to 'prod'

* run `docker-compose up -d`

* explore