File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -8,43 +8,39 @@ https://python.microformats.io
88
99All commits to the ` master ` branch get auto-deployed to the live website (running on [ Heroku] ( https://python.microformats.io ) )
1010
11+ ## Getting Started
1112
12- ## Requirements
13-
14- - Python 2.7
15-
13+ This website is built using Python Flask.
1614
17- ## Installation
18-
19- Clone the repo:
15+ To start working with this project, first clone the repository for this project:
2016
2117```
2218git clone https://github.com/indieweb/microformats-python-parser-website.git
2319cd microformats-python-parser-website
2420```
2521
26- Install the dependencies:
22+ Next, install the required dependencies:
2723
2824```
29- TODO
25+ pip3 install -r requirements.txt
3026```
3127
32- Start the server:
28+ Next, start the server. You can do this in either debugging mode (where ` debug=True ` ) in Flask or in production mode using Gunicorn.
3329
3430```
35- TODO
31+ python3 app.py --debug (debug mode)
32+ gunicorn app:app (production mode)
3633```
3734
38- Open the site in your browser :
35+ You can view your running local application at this URL :
3936
4037```
41- TODO
38+ http://localhost:8080
4239```
4340
41+ ## Requirements
4442
45- ## Authors
46-
47- - Kyle Mahan / [ @kylewm ] ( https://github.com/kylewm )
43+ - Python 3.9
4844
4945## Contributions
5046
5854If you find bugs, have feature requests or questions, please
5955[ file an issue] ( https://github.com/indieweb/microformats-parser-website-python/issues ) .
6056
61-
6257## License
6358
6459Microformats Python Parser Website is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal.
6560
6661http://creativecommons.org/publicdomain/zero/1.0
62+
63+ ## Contributors
64+
65+ - Kyle Mahan / [ @kylewm ] ( https://github.com/kylewm ) (Author)
66+ - [ @capjamesg ] ( https://github.com/capjamesg ) (Contributor)
You can’t perform that action at this time.
0 commit comments