https://github.com/moemoe89/simple-api-flask
🐍 This repo for practicing Simple API using Python (Flask Framework), PostgreSQL, Docker
https://github.com/moemoe89/simple-api-flask
docker flask postgresql python python-3
Last synced: 2 months ago
JSON representation
🐍 This repo for practicing Simple API using Python (Flask Framework), PostgreSQL, Docker
- Host: GitHub
- URL: https://github.com/moemoe89/simple-api-flask
- Owner: moemoe89
- Created: 2020-04-11T01:26:21.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T21:39:17.000Z (about 3 years ago)
- Last Synced: 2025-01-20T16:18:15.048Z (over 1 year ago)
- Topics: docker, flask, postgresql, python, python-3
- Language: Python
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# simple-api-flask #
Simple API Flask using Python as Programming Language (Flask Framework), PostgreSQL as Database
### Requirements
Simple API is currently extended with the following requirements. Instructions on how to use them in your own application are linked below.
| Requirement | Version |
| ----------- | ---------- |
| Python | >= 3.7.7 |
| PIP | >= 20.0.2 |
| Flask | >= 1.1.2 |
| PosgtreSQL | >= 12.0 |
### Setup
* Setup Python
* Setup PIP
* Setup Flask
* Setup PostgreSQL
### Installation
Make sure you the requirements above already install on your system. Or you could easily run with Docker to make your environment clean.
Clone the project to your directory and install the dependencies.
```sh
$ git clone git@github.com:moemoe89/simple-api-flask.git
$ cd simple-api-flask
$ pipenv install
```
Setup your environments.
```sh
$ cp .env.example .env
```
Change your PostgreSQL credentials depends on your PostgreSQL installed config.
```sh
FLASK_ENV=development
DATABASE_URL=postgres://postgres@127.0.0.1:5432/simple_api
JWT_SECRET_KEY=secret_key
```
### Migrate
Setup your migration following by this command.
```sh
$ python3 manage.py db init
$ python3 manage.py db migrate
$ python3 manage.py db upgrade
```
### Run Application
For run application:
```sh
$ python3 run.py
```
Verify the apllication by navigating to your server address in your preferred browser.
```sh
127.0.0.1:5000
```
### Docker
Simple API is very easy to install and deploy in a Docker container. Simply use the docker-compose build to build the image.
```sh
$ docker-compose build
```
Once done, run the Docker image by using docker-compose up command.
```sh
$ docker-compose up -d
```
Verify the application by navigating to your server address in your preferred browser.
```sh
127.0.0.1:5000
```
Stop application could be done with docker-compose stop command.
```sh
$ docker-compose stop
```
License
----
MIT