updated readme
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
# CA-Lose
|
# LuckySign
|
||||||
|
|
||||||
Ticket intake and validation app with a React frontend and an Express + MySQL backend.
|
Ticket intake and validation app with a React frontend and an Express + MySQL backend.
|
||||||
|
|
||||||
@@ -9,14 +9,22 @@ Ticket intake and validation app with a React frontend and an Express + MySQL ba
|
|||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
[](#)
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
|
### Production Tech Stack
|
||||||
|
|
||||||
|
> **Note**: For production, check the [prod branch](prod) which contains an VPN git submodule of wg-easy to run the app securely on a private network. It also contains a dnsmasq container to resolve the backend service name from the frontend container. The main branch is meant for local development and testing, so it doesn't include those components to keep things simple.
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
- Frontend (Vite + React + Tailwind + MUI): [frontend](frontend)
|
- Frontend (Vite + React + Tailwind + MUI): [frontend](frontend)
|
||||||
@@ -29,7 +37,7 @@ Ticket intake and validation app with a React frontend and an Express + MySQL ba
|
|||||||
1. Set the database password env var used by Docker Compose:
|
1. Set the database password env var used by Docker Compose:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export DB_PASSWORD=your_password
|
DB_PASSWORD=your_password
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Start MySQL and the backend:
|
2. Start MySQL and the backend:
|
||||||
@@ -42,6 +50,7 @@ Notes:
|
|||||||
|
|
||||||
- The frontend service is commented out in [docker-compose.yml](docker-compose.yml). If you want the frontend container, uncomment that block and rebuild.
|
- The frontend service is commented out in [docker-compose.yml](docker-compose.yml). If you want the frontend container, uncomment that block and rebuild.
|
||||||
- The frontend container uses Nginx and proxies /backend to the backend service (see [frontend/nginx.conf](frontend/nginx.conf)).
|
- The frontend container uses Nginx and proxies /backend to the backend service (see [frontend/nginx.conf](frontend/nginx.conf)).
|
||||||
|
- In order to use the database properly, run the scheme and create some users in the users table.
|
||||||
|
|
||||||
## Local Development
|
## Local Development
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user