Setup pipenv and update README

HarshShah1997 · Mar 25, 2022 · b013935 · b013935
1 parent 85f3eb8
commit b013935
Show file tree

Hide file tree

Showing 4 changed files with 142 additions and 2 deletions.
diff --git a/Pipfile b/Pipfile
@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+flask = "*"
+pysqlite3 = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.8"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -7,6 +7,19 @@ A simple E-commerce website using Flask.
 3. Sqlite
 
 ## How to run ##
-1. Set up database by running database.py
+1. Set up database by running database.py (Or you can reuse existing database included in the repo)
 2. Run main.py
-3. Enter localhost:5000 in the browser.
+3. Enter localhost:5000 in the browser
+
+## Pipenv instructions ##
+1. Install pipenv (python3 -m pip install --user pipenv)
+2. Install dependencies (pipenv install --dev)
+3. Setup database (pipenv run python database.py)
+4. Run the server (pipenv run python main.py)
+5. Enter localhost:5000 in the browser
+
+## Sample User ##
+Sample credentials present in existing database:
+Username - sample@example.com
+Password - sample
+
diff --git a/database.db b/database.db