admin/demo_partsERP
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix(Content): Improved format of README.

Browse Source
This commit is contained in:
Teddy Middleton-Smith
2025-02-25 17:41:55 +00:00
parent 1b11001a3f
commit fc0f901179
1 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -1,51 +1,51 @@
## demo_partsERP # demo_partsERP
Demo subproject of partsERP Enterprise Resource Planning system featuring the core product functionality. 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. This web app uses Python with Flask for the server and MySQL for the database.
## Build And Run # Build And Run
# 0. Prerequisites ## 0. Prerequisites
- Python 3.10 - Python 3.10
- npm - npm
- Locally hosted MySQL database - 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. 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.1. Go to the reCAPTCHA Admin Console and register your site: https://www.google.com/recaptcha/admin
2.2. Choose reCAPTCH v2 2.2. Choose reCAPTCH v2
2.3. Generate and save keys for step 10 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. 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 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.1. Sign into your local MySQL workspace
4.2. Run script static/MySQL/0000_combined.sql 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.1. Open a new terminal window
5.2. Navigate to the project with the following command 5.2. Navigate to the project with the following command
- cd path/to/project/main/directory - cd path/to/project/main/directory
# 6. Create virtual environment ## 6. Create virtual environment
6.1. Terminal command 6.1. Terminal command
python3 -m venv env_demo_partsERP python3 -m venv env_demo_partsERP
# 7. Enter virtual environment ## 7. Enter virtual environment
7.1. Terminal command 7.1. Terminal command
source env_demo_partsERP/bin/activate source env_demo_partsERP/bin/activate
# 8. Run module bundler ## 8. Run module bundler
8.1. Terminal command 8.1. Terminal command
npm run build npm run build
# 9. Install required python packages ## 9. Install required python packages
9.1. Terminal command 9.1. Terminal command
pip3 install -r requirements.txt pip3 install -r requirements.txt
# 10. Set required environment variables ## 10. Set required environment variables
10.1. Windows command 10.1. Windows command
SET variable_name=variable_value 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_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 | | RECAPTCHA_PRIVATE_KEY | Private key for Google ReCAPTCHA. Required for bot-prevention mesaures on Contact Us page form. | erDasdku8asdncuSAAS88C71nSioRR2rerDasdku |
# 11. Host project ## 11. Host project
# Either: ## Either:
- Host for local machine - Host for local machine
python3 -m flask run python3 -m flask run
@@ -80,8 +80,8 @@ python3 -m flask run
python3 -m flask run --host=0.0.0.0 python3 -m flask run --host=0.0.0.0
## File Structure # File Structure
# Files dedicated to each page ## Files dedicated to each page
CSS: CSS:
page page
HTML: HTML: