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:46:10 +00:00
parent fc0f901179
commit 147f73fc89
1 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@@ -31,33 +31,33 @@ NOTE: IF CONTACT US PAGE FORM FUNCTIONALITY IS REQUIRED, COMPLETE THIS STEP.
## 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 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| KEY_SECRET_FLASK | Private key for server encryption. | password123 | | KEY_SECRET_FLASK | Private key for server encryption. | password123 |
| ID_AUTH0_CLIENT | Public identifier for project's Auth0 application. | erDasdku8asdncuSAAS88C71nSioRR2r | | ID_AUTH0_CLIENT | Public identifier for project's Auth0 application. | erDasdku8asdncuS... |
| ID_AUTH0_CLIENT_SECRET | Private key for project's Auth0 application. | erDasdku8asdncuSAAS88C71nSioRR2rerDasdku8asdncuSAAS88C71nSioRR2r | | ID_AUTH0_CLIENT_SECRET | Private key for project's Auth0 application. | erDasdku8asdncuSAAS88... |
| DOMAIN_AUTH0 | Domain for requests related to project's Auth0 application. | dev-pdjf9043dsau7fas8fs.us.auth0.com | | DOMAIN_AUTH0 | Domain for requests related to project's Auth0 application. | dev-pdjf9043dsau7fas8fs.us.auth0.com |
| SQLALCHEMY_DATABASE_URI | Database connection string for SQLAlchemy. | mysql://db_user_name:db_password@127.0.0.1:3306/db_name | | SQLALCHEMY_DATABASE_URI | Database connection string for SQLAlchemy. | mysql://db_user_name:db_password@127.0.0.1:3306/db_name |
| URL_HOST | Domain (and port as necessary) that the project is hosted on. | https://127.0.0.1:5000/ | | URL_HOST | Domain (and port as necessary) that the project is hosted on. | https://127.0.0.1:5000/ |
@@ -68,39 +68,39 @@ export variable_name=variable_value
| MAIL_DEFAULT_SENDER | Bot email address. Required for sending internal emails following form completion on Contact Us page. | bot@partsltd.co.uk | | MAIL_DEFAULT_SENDER | Bot email address. Required for sending internal emails following form completion on Contact Us page. | bot@partsltd.co.uk |
| MAIL_CONTACT_PUBLIC | Company's public communications email address. Required for receiving internal emails following form completion on Contact Us page. | teddy@partltd.co.uk | | MAIL_CONTACT_PUBLIC | Company's public communications email address. Required for receiving internal emails following form completion on Contact Us page. | teddy@partltd.co.uk |
| MAIL_PASSWORD | Password for bot email account. Required for receiving internal emails following form completion on Contact Us page. | password123 | | MAIL_PASSWORD | Password for bot email account. Required for receiving internal emails following form completion on Contact Us page. | password123 |
| 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.| erDasdku8asdncuSAAS88... |
| 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. | erDasdku8asdncuSAAS8... |
## 11. Host project ## 11. Host project
## Either: NOTE: DO EITHER 11.1 OR 11.2.
- Host for local machine 11.1. Host for local machine
python3 -m flask run - python3 -m flask run
- Host for local network 11.2. 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