Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
byronbenharris authored Sep 19, 2021
1 parent 047ba01 commit 726468e
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# EZ PowerPoint

EZPPT runs Natural Language Processing algorithms that is able to analyze a DOCX document and return a powerpoint file with the most important points summarized into a neat powerpoint template that is ready to use with only a few tweaks from the user.


## Local Instructions
1. `python3 -m venv venv`
1. `source venv/bin/activate`
1. `pip install -r requirements.txt`
1. restart so bootstrap-flask loads
## Local Development Instructions

1. `export FLASK_APP=flaskr`
1. `export FLASK_ENV=development`
1. `flask run`
1. Clone the project
2. CD to root directory
3. Run `python3 -m venv venv` to create a new virtual env
4. Run `source venv/bin/activate` to start the virtual env
5. Run `pip install -r requirements.txt` to install project dependencies
6. Run `deactivate` and `source venv/bin/activate` to restart the virtual env to load bootstrap-flask (the package has a bug)
1. Run `export FLASK_APP=flaskr` and `export FLASK_ENV=development` to set env variables
1. Run `flask run` to start the server
2. Navigate to [http://127.0.0.1:5000/] to see the product!

0 comments on commit 726468e

Please sign in to comment.