https://github.com/josethz00/flask_api_template

Basic Flask API template to setup quickly your projects, right to the code, using Flask, Flask-Mail, Threads and SQLAlchemy
https://github.com/josethz00/flask_api_template

async flask python template

Last synced: 3 days ago
JSON representation

Basic Flask API template to setup quickly your projects, right to the code, using Flask, Flask-Mail, Threads and SQLAlchemy

• Host: GitHub
• URL: https://github.com/josethz00/flask_api_template
• Owner: josethz00
• Created: 2021-02-03T22:11:02.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-05T02:28:31.000Z (almost 4 years ago)
• Last Synced: 2024-11-15T04:39:16.290Z (2 months ago)
• Topics: async, flask, python, template
• Language: Python
• Homepage:
• Size: 94.7 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Flask API template 🤯🤯🤯

This is a public repository with contents of Flask Web Development, here you will find examples applied in a Restful API, and a basic and flexible structure to start your Flask apps.




Steps to run this app 👇👇👇




1- Check if you have Python (3.2 or +) installed

-----------------------------------

Type in your terminal (Windows):


```

$ python

```

Type in your terminal (Unix):


```

$ python3

```

If no errors were shown, it means that you already have Python installed


2- Installing Python (skip this if you already have Python installed)

-----------------------------------

 - https://www.python.org/downloads/release/python-392/

 - ``` $ sudo apt-get install python3.9 ```

 - ``` brew install python3 ```

3- Cloning repo

-----------------------------------

```

$ git clone https://github.com/josethz00/flask_api_template

```

4- Enter in folder

-----------------------------------

```

$ cd server

```

5- Install the requirements

-----------------------------------

```

$ pip3 install -r requirements/requirements.txt

```

6- Start Flask server

-----------------------------------

```

$ python3 run.py

```




## Check some default env variables (available on ``` config/variables.py ```)

| Env Variable  | Default Value |

| ------------- | ------------- |

| HOST  | '0.0.0.0'  |

| PORT  | '8080' |

| DEBUG | True |