https://github.com/cryptaliagy/uottahack7
https://github.com/cryptaliagy/uottahack7
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/cryptaliagy/uottahack7
- Owner: cryptaliagy
- Created: 2025-01-18T14:14:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-19T14:50:43.000Z (over 1 year ago)
- Last Synced: 2025-02-01T03:28:47.296Z (over 1 year ago)
- Language: Python
- Size: 147 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# uOttaHack 7 Project
## Getting Started
### Prerequisites (for running project)
- [Docker](https://docs.docker.com/engine/install/)
- [Docker-Compose](https://docs.docker.com/engine/install/) - Comes with Docker Desktop
### Prerequisites (development)
See the specific README.md in the `frontend` and `backend` directories.
### Quickstart
1. Clone the repository
1. Build all containers with the `docker compose build` command
1. Setup the `.env` file in the top-level directory (see below)
1. Start the containers with the `docker compose up` command
### Environment Variables
To connect to the database, some environment variables are required. To set these up, create a black file called `.env` in your top-level directory, and add the following:
```env
MYSQL_ROOT_PASSWORD=
MYSQL_DATABASE=database
CONNECTION_STRING=mysql+pymysql://root:@db:3306/database
```
> Note: replace `` with your desired password. You may also change the value of `MYSQL_DATABASE` if you wish, but ensure that the `CONNECTION_STRING` is updated accordingly.
> IMPORTANT: This is not a secure setup and is assumed for development purposes only. It is highly encouraged to not use `root` as the database user in a production environment.
This file will then be read by the `docker-compose.yml` file to set the environment variables for the database container.