From fc0f9011792cd28ef68c6ed11101e04edde6d4d7 Mon Sep 17 00:00:00 2001 From: Teddy Middleton-Smith Date: Tue, 25 Feb 2025 17:41:55 +0000 Subject: [PATCH] Fix(Content): Improved format of README. --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 0fad7678..735c99a6 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,51 @@ -## demo_partsERP +# demo_partsERP Demo subproject of partsERP Enterprise Resource Planning system featuring the core product functionality. This web app uses Python with Flask for the server and MySQL for the database. -## Build And Run -# 0. Prerequisites +# Build And Run +## 0. Prerequisites - Python 3.10 - npm - Locally hosted MySQL database -# 1. Create Auth0 application for project +## 1. Create Auth0 application for project -# 2. (Optional) Create Google ReCAPTCHA service +## 2. (Optional) Create Google ReCAPTCHA service NOTE: IF CONTACT US PAGE FORM FUNCTIONALITY IS REQUIRED, COMPLETE THIS STEP. 2.1. Go to the reCAPTCHA Admin Console and register your site: https://www.google.com/recaptcha/admin 2.2. Choose reCAPTCH v2 2.3. Generate and save keys for step 10 -# 3. (Optional) Create bot email account +## 3. (Optional) Create bot email account NOTE: IF CONTACT US PAGE FORM FUNCTIONALITY IS REQUIRED, COMPLETE THIS STEP. 3.1. Using your chosen email provider, create a new account for sending emails from the web server -# 4. Create and populate database +## 4. Create and populate database 4.1. Sign into your local MySQL workspace 4.2. Run script static/MySQL/0000_combined.sql -# 5. Open the project in a new terminal window +## 5. Open the project in a new terminal window 5.1. Open a new terminal window 5.2. Navigate to the project with the following command - cd path/to/project/main/directory -# 6. Create virtual environment +## 6. Create virtual environment 6.1. Terminal command python3 -m venv env_demo_partsERP -# 7. Enter virtual environment +## 7. Enter virtual environment 7.1. Terminal command source env_demo_partsERP/bin/activate -# 8. Run module bundler +## 8. Run module bundler 8.1. Terminal command npm run build -# 9. Install required python packages +## 9. Install required python packages 9.1. Terminal command pip3 install -r requirements.txt -# 10. Set required environment variables +## 10. Set required environment variables 10.1. Windows command SET variable_name=variable_value @@ -71,8 +71,8 @@ export variable_name=variable_value | RECAPTCHA_PUBLIC_KEY | Public key for Google ReCAPTCHA. Required for bot-prevention mesaures on Contact Us page form.| erDasdku8asdncuSAAS88C71nSioRR2rerDasdku | | RECAPTCHA_PRIVATE_KEY | Private key for Google ReCAPTCHA. Required for bot-prevention mesaures on Contact Us page form. | erDasdku8asdncuSAAS88C71nSioRR2rerDasdku | -# 11. Host project -# Either: +## 11. Host project +## Either: - Host for local machine python3 -m flask run @@ -80,8 +80,8 @@ python3 -m flask run python3 -m flask run --host=0.0.0.0 -## File Structure -# Files dedicated to each page +# File Structure +## Files dedicated to each page CSS: page HTML: