https://github.com/ondiekelijah/basic-flask-api
A typical Flask API
https://github.com/ondiekelijah/basic-flask-api
flask python
Last synced: about 1 month ago
JSON representation
A typical Flask API
- Host: GitHub
- URL: https://github.com/ondiekelijah/basic-flask-api
- Owner: ondiekelijah
- License: mit
- Created: 2021-12-03T13:44:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-28T07:13:07.000Z (over 2 years ago)
- Last Synced: 2025-03-24T01:35:29.145Z (about 2 months ago)
- Topics: flask, python
- Language: Python
- Homepage: https://flaskapitemplate.azurewebsites.net
- Size: 29.3 KB
- Stars: 6
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://dl.circleci.com/status-badge/redirect/gh/Dev-Elie/basic-Flask-API/tree/main)
[](https://github.com/Dev-Elie/basic-Flask-API/actions/workflows/main_flaskapitemplate.yml)
## Initial Set Up Instructions
### 1 .Clone the git repo and create an environment
**Windows**
```bash
git clone https://github.com/Dev-Elie/Flask-API-boilerplate.git Flask-API
cd Flask-API
py -3 -m venv venv
```
**macOS/Linux**
```bash
git clone https://github.com/Dev-Elie/Flask-API-boilerplate.git Flask-API
cd Flask-API
python3 -m venv venv
```
### 2 .Activate the environment
**Windows**
```venv\Scripts\activate```
**macOS/Linux**
```. venv/bin/activate```
or
```source venv/bin/activate```
### 3 .Install the requirements
Applies for windows/macOS/Linux
```pip install -r requirements.txt```
### 4. Initialize a database
`python db_init.py`
### 5. Run the application
`python wsgi.py`
### 6. Running tests
`pytest -v`