Fix(Content): Improved format of README.
This commit is contained in:
98
README.md
98
README.md
@@ -1,5 +1,5 @@
|
|||||||
## 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
|
||||||
@@ -11,46 +11,46 @@ This web app uses Python with Flask for the server and MySQL for the 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
|
||||||
|
|
||||||
10.2. Linux command
|
10.2. Linux command
|
||||||
export variable_name=variable_value
|
export variable_name=variable_value
|
||||||
|
|
||||||
10.3. Required variables
|
10.3. Required variables
|
||||||
| Name | Purpose | Example Value |
|
| Name | Purpose | Example Value |
|
||||||
@@ -72,35 +72,35 @@ export variable_name=variable_value
|
|||||||
| 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:
|
||||||
11.1. Host for local machine:
|
- Host for local machine
|
||||||
python3 -m flask run
|
python3 -m flask run
|
||||||
|
|
||||||
11.2. Host for local network:
|
- Host for local network
|
||||||
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:
|
||||||
page
|
page
|
||||||
row
|
row
|
||||||
JavaScript:
|
JavaScript:
|
||||||
page
|
page
|
||||||
api
|
api
|
||||||
router
|
router
|
||||||
base - navigation buttons
|
base - navigation buttons
|
||||||
MySQL:
|
MySQL:
|
||||||
get
|
get
|
||||||
save
|
save
|
||||||
table
|
table
|
||||||
staging table
|
staging table
|
||||||
audit table
|
audit table
|
||||||
Python:
|
Python:
|
||||||
business object
|
business object
|
||||||
controller
|
controller
|
||||||
datastore
|
datastore
|
||||||
form
|
form
|
||||||
model
|
model
|
||||||
Reference in New Issue
Block a user