---

🧰 Requirements

Supported operating systems:

• Ubuntu LTS/Debian 9.x
• CentOS/RHEL 8
• macOS Mojave
• Docker

Node:

• Recommended: 16.x
• Minimum: 14.x

MySQL:

• Recommended: 8.0
• Minimum: 5.7.8

---

🚀 Getting Started

docker compose up --detach --wait --build

---

💻 Development

Client

Folder: /client

Install Dependencies

npm install

Start Client

npm run dev

Server

Folder: /server

Install Dependencies

npm install

Start Server

npm run dev-start

Environment Vars

Var	Type	Default Value	Description
SECRET	String	THIS IS A SECRET	Used to encrypt passwords on the database
DB_HOST	String	localhost	Database connection host
DB_PORT	Number	3306	Database connection port
DB_USER	String	root	Database connection user
DB_PASSWORD	String	root	Database connection password
DB_SCHEMA	String	testdb	Database name
PORT	Number	8080	Server port number
FORCE_DB_SYNC	Boolean	false	Force database structure creation
DEBUG	Boolean	false	Enables the debug mode
CORS_ORIGIN	String	*	Origin hosts list separated by comma, allowed to make requests (* means all allowed)
REDIS_URL	String	redis://localhost:6380	The redis connection url
LOG_LEVEL	String	INFO	The LOG_LEVEL specifies the minimum level to log for selected categories
ENVIRONMENT	String		Indicates the environment where the server is running

---

📖 API Documentation

🗄️ Database

MySQL use as Database.

---

💾️ Backups

Backups are stored in Azure Containers data storage.

Folder: /backup-script

Automatic Executions

• On every push to main
• Every Saturday at 8AM (UTC-3)

Install Dependencies

npm install

Run Backup

npm run backup

Environment Vars

Var	Type	Default Value	Description
DB_HOST	String	localhost	Database connection host
DB_PORT	Number	3306	Database connection port
DB_USER	String	root	Database connection user
DB_PASSWORD	String	root	Database connection password
DB_SCHEMA	String	testdb	Database name
AZURE_ACCOUNT	String	null	Azure account name
AZURE_ACCOUNT_KEY	String	null	Azure account secret key

---

⚖️ License

This project is licensed under the terms of the MIT license.

You can check out the full license MIT license.