Update README
This commit is contained in:
parent
9b687687f2
commit
fadafbdee9
33
README.md
33
README.md
|
@ -1,3 +1,36 @@
|
|||
# flask_api_example
|
||||
|
||||
A sample project showing how to build a scalable, maintainable, modular Flask API with a heavy emphasis on testing.
|
||||
|
||||
## Running the app
|
||||
|
||||
Preferably, first create a virtualenv and activate it, perhaps with the following command:
|
||||
|
||||
```
|
||||
virtualenv -p python3 venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
Next, run
|
||||
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
to get the dependencies.
|
||||
|
||||
Next, initialize the database
|
||||
|
||||
```
|
||||
python manage.py seed_db
|
||||
```
|
||||
|
||||
Type "Y" to accept the message (which is just there to prevent you accidentally deleting things -- it's just a local SQLite database)
|
||||
|
||||
Finally run the app with
|
||||
|
||||
```
|
||||
python wsgi.py
|
||||
```
|
||||
|
||||
Navigate to the posted URL in your terminal to be greeted with Swagger, where you can test out the API.
|
||||
|
|
Loading…
Reference in New Issue
Block a user