Skip to content

improve readme #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eduardlorente merged 1 commit into from
Oct 4, 2026
Merged

improve readme #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ Use this pre-seeded account to evaluate both the live Web application and mobile
|---|---|---|
| `user` | `password` | Workout tracking, personal routines, exercises, body metrics |

> [!NOTE]
> **Live vs. Local Environment**:
> While the table above points to the public cloud deployments, you can run the full containerized environment demonstrated in the video (API + MySQL + Scalar UI) locally by executing:
> ```powershell
> ./StartDockerScript.ps1
> ```
> This script builds and starts the local Docker containers and exposes the API with interactive Scalar documentation at `http://localhost:5000/scalar/v1`. See [Getting Started](#getting-started) for prerequisite setup.

---

## Key Features
Expand Down Expand Up @@ -119,11 +127,11 @@ cd GymTron
MYSQL_DATABASE=gymtron
JWT_SECRET_KEY=Your32ByteMinimumSecretKeyHere!
```
2. Start the MySQL container:
2. Start the containers (Database & API):
```powershell
./StartDockerScript.ps1
```
*Alternatively, run `docker compose up -d`.*
*Alternatively, run `docker compose up -d` to start the database container only.*

### 3. Application Configuration

Expand Down
Loading