generated from Blog/Python-Flask-Template
Add README informations
This commit is contained in:
42
README.md
42
README.md
@@ -1,3 +1,41 @@
|
|||||||
# Python-Flask-Template
|
# OpenSIRP-API
|
||||||
|
|
||||||
Template pour créer une API REST en Python avec Flask, SQLAlchemy, Marshmallow et JWT pour l'authentification
|
OpenSIRP is an OpenSource SIRP (Security Incident Response Plateform). This repository is the backend of the project.
|
||||||
|
|
||||||
|
## Get Started
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
Before install backend, you need:
|
||||||
|
- python 3.10+
|
||||||
|
- python-pip
|
||||||
|
|
||||||
|
|
||||||
|
### Install
|
||||||
|
In command terminal:
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://gitea.verbaere.com/openSIRP/openSIRP-API.git
|
||||||
|
cd openSIRP-API
|
||||||
|
```
|
||||||
|
|
||||||
|
*Optional (If you want run in python virtual env)*
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
python3 -m venv en
|
||||||
|
source env/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
Install lib with pip
|
||||||
|
```
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configure
|
||||||
|
Open ```config.py``` file on set you personal settings
|
||||||
|
|
||||||
|
### Run
|
||||||
|
Launch the API
|
||||||
|
```
|
||||||
|
python -m flask run
|
||||||
|
```
|
Reference in New Issue
Block a user