Skip to content

Commit e2c92a1

Browse files
committed
update README
1 parent 037f640 commit e2c92a1

File tree

4 files changed

+36
-0
lines changed

4 files changed

+36
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Flask Simple From
2+
This is a simple flask register-form application designed to run in multiple ways:
3+
4+
# Overview
5+
![index](/img/index.png)
6+
7+
# Running this app
8+
9+
This app is designed to run in different ways:
10+
1. As a standalone app running on your machine
11+
12+
## 1. As a standalone app
13+
14+
1. install [python](https://www.python.org/)
15+
2. `git clone` the project then `cd` into the directory
16+
3. run `virtualenv -p /usr/bin/python3 venv`or `python -m venv venv` to create a virtual environment
17+
4. activate it using `source venv/bin/activate`
18+
5. `pip install -r requirements/dev.txt` to install the app libaries and it dependencies
19+
20+
### running the app
21+
22+
* After installing, you need to set your application _environment variable_ by running `export FLASK_APP=app.py`
23+
* run the server using `flask run --reload --debugger`
24+
* Access the running app in a browser at the URL written to the console (most likely http://localhost:5000)
25+

app.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from app import app
2+
3+
4+
if __name__ == '__main__':
5+
app.run(debug=True)

img/index.png

71.7 KB
Loading

requirements/dev.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Click==7.0
2+
Flask==1.1.1
3+
itsdangerous==1.1.0
4+
Jinja2==2.10.1
5+
MarkupSafe==1.1.1
6+
Werkzeug==0.15.5

0 commit comments

Comments
 (0)