diff --git a/README.md b/README.md index 25ea2637d431530ed6138346d5cd67ca19f22bef..99f24e2bad0617f6195a1c617ececa6b3021c3cc 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,23 @@ create venv # 3: Env -create `.env` file based on `.env.example` in the main directory +create `.env` file based on `.env.example` in the main directory \\ +change to your own MySQL username, password -# 4: Run Backend API on your local machine +# 4: Run App + +To run the full application (backend + frontend): + +``` +python run_app.py +``` + +# 5: Run Backend API on your local machine - open terminal and use `uvicorn app.backend.main:app --reload` - open `127.0.0.1:8000/docs` on your browser -# 5: Admin Dashboard +# 6: Admin Dashboard The application includes an admin dashboard with the following features: @@ -31,9 +40,3 @@ The application includes an admin dashboard with the following features: - Password: admin The default admin user is automatically created on first run of the application. - -To run the full application (backend + frontend): - -``` -python run_app.py -``` diff --git a/instructions.txt b/instructions.txt new file mode 100644 index 0000000000000000000000000000000000000000..76314f529722c9a3ebdc449b637aa3349e111b95 --- /dev/null +++ b/instructions.txt @@ -0,0 +1,15 @@ +1. Create venv, activate venv and install required libraries +pip install -r requirements.txt + +2. Make sure you have MySQL installed +- Create a schema called 'shopping' with 'utf8' charset and 'utf8_unicode_ci' collection + +3. Create your own `.env` file based on `.env.example` +- change to your own MySQL username, password + +4. Make sure you cd into the directory + +5. Run 'run_app.py' + +6. (Optional) if you want to just run the backend, use in command line +uvicorn app.backend.main:app --reload diff --git a/pdf/element2_methodology.pdf b/pdf/element2_methodology.pdf new file mode 100644 index 0000000000000000000000000000000000000000..4e4df6e99383b1277661aaae398af8d12b64cbf6 Binary files /dev/null and b/pdf/element2_methodology.pdf differ