🦀 ShellCon Smart Aquarium – Full-Stack Challenge Guide 🐚

Welcome to ShellCon, an onboarding playground where you will repair a broken Smart Aquarium while learning Rust and Shuttle Cloud.
When you launch the dashboard, read the short Scenario banner at the top. It sets the story context and your mission before you start clicking around.

This monorepo contains everything:

• Three Rust micro-services (aqua-monitor, species-hub, aqua-brain).
• A React + Vite dashboard (frontend/).

Your mission has three phases:

1. Get it running – start every service & the UI locally; verify every dashboard button works.
2. Fix performance bugs – complete four optimisation challenges inside the services.
3. Ship to the cloud & celebrate – deploy with Shuttle.

---

📂 Repo layout

services/
  aqua-monitor/   # environmental sensors  (Challenges 1 & 4)
  species-hub/    # species DB             (Challenge 2)
  aqua-brain/     # analytics engine       (Challenge 3)
frontend/         # React dashboard

---

🛠️ Prerequisites

• Rust 1.70+ & Cargo
• Docker Desktop (Postgres for local Shuttle)
• Shuttle CLI (latest)
• Node ≥16 & npm (or Yarn/Bun)

🔑 One-time Shuttle setup

Install or update the Shuttle CLI, then log in before running any shuttle run or shuttle deploy commands.

# Install / update the CLI
curl -sSfL https://www.shuttle.dev/install | bash

# Authenticate (opens a browser for sign-in or account creation)
shuttle login

---

🚀 Quick-start – Local

1 · Launch the back-end services

First off, clone this repository on your local machine:

# Clone the repository
git clone https://github.com/shuttle-hq/shuttle-shellcon.git
# Change directory to the cloned repository
cd shuttle-shellcon

Run the following commands in three separate terminals:

# Terminal 1
cd shellcon-backend/services/aqua-monitor && shuttle run --port 8000
# Terminal 2
cd shellcon-backend/services/species-hub  && shuttle run --port 8001
# Terminal 3
cd shellcon-backend/services/aqua-brain  && shuttle run --port 8002

If a port is busy: lsof -ti :<port> | xargs kill -9 then retry. Alternatively, you can use the environment files to customize the ports as shown in the "Environment files – local development" section below.

2 · Start the dashboard & confirm every API call locally

Open a new terminal and run the following commands at the root of the repository:

cd shellcon-frontend
npm install                 # first time only
npm run dev:localhost        # opens http://localhost:8080

Then open http://localhost:8080 in your browser and click "Read Story Now" to begin the ShellCon scenario.

In the System Control Panel click each button – no red errors should appear.

UI action	Request	Service
View all tanks	GET /api/tanks	aqua-monitor
Fetch tank readings	GET /api/tanks/{id}/readings	aqua-monitor
Check sensor status	GET /api/sensors/status	aqua-monitor
List all species	GET /api/species	species-hub
Get species details	GET /api/species/{id}	species-hub
Get feeding schedule	GET /api/species/{id}/feeding-schedule	species-hub
View all tank analysis	GET /api/analysis/tanks	aqua-brain
Tank health analysis	GET /api/analysis/tanks/{id}	aqua-brain

Challenges only affect performance/validation – the endpoint contracts above stay identical before & after solving them.

---

🖥️ Frontend dashboard tour

The dashboard is split into five panels:

Panel	What it shows
Scenario Banner (top)	A short narrative that frames why you are fixing the aquarium – read it first!
System Control Panel	Action buttons that call the REST endpoints listed above.
System Status	Live backend connectivity and challenge status shown as Normal or Error/Degraded.
Optimization Challenges	Cards describing each challenge with Show Hint, Validate, View Solution, and Teach Me How It Works buttons.

---

⚙️ Environment files – local development (.env.localhost)

IMPORTANT: Use the following custom environment variables ONLY if ports 8000-8002 are already in use on your machine.

vite.config.ts looks for three variables but falls back to the default localhost ports 8000-8002:

VITE_AQUA_MONITOR_URL    (default http://localhost:8000)
VITE_SPECIES_HUB_URL     (default http://localhost:8001)
VITE_AQUA_BRAIN_URL      (default http://localhost:8002)

You override them by specifying other ports, as shown in the example below.

Steps:

1. touch frontend/.env.localhost and adjust if needed.
2. Restart the dev server whenever you edit an .env* file.

File	When Vite picks it up	Typical use
.env.localhost	npm run dev:localhost	Custom local ports or running services on another host.

Example .env.localhost (custom ports):

# Local development backend services
VITE_AQUA_MONITOR_URL=http://localhost:8020
VITE_SPECIES_HUB_URL=http://localhost:8021
VITE_AQUA_BRAIN_URL=http://localhost:8022
VITE_API_BASE_URL=/api  # leave as /api unless you modify the proxy rules

---

3 · Solve the optimisation challenges

#	Location	Topic
1	aqua-monitor/src/challenges.rs::get_tank_readings	Async I/O
2	species-hub/src/challenges.rs::get_species	SQL optimisation
3	aqua-brain/src/challenges.rs::get_analysis_result	String allocations
4	aqua-monitor/src/challenges.rs::get_sensor_status	HTTP-client reuse

Workflow per challenge:

1. Read the lecture / hint.
2. Edit the code inside the marked // ⚠️ CHALLENGE block.
3. For some challenges, you’ll also need to modify main.rs to adjust relevant structures and functions so they can be imported in challenges.rs.
4. Re-run only that service (Ctrl-C, then shuttle run --port …).
5. Click Validate in the UI.

Complete all four – the UI unlocks confetti! 🎉

---

☁️ Deploy & validate in the cloud

1. For each service:

   cd services/<service>
   shuttle deploy
   # choose “CREATE NEW”, project name = folder name (e.g aqua-brain)

2. Configure the frontend for cloud:

   # create the env file once (or edit it if it already exists)
   touch frontend/.env.prod

   Open frontend/.env.prod and paste the URLs printed by each shuttle deploy command:

   VITE_AQUA_MONITOR_URL=https://<aqua-monitor>.shuttleapp.app
   VITE_SPECIES_HUB_URL=https://<species-hub>.shuttleapp.app
   VITE_AQUA_BRAIN_URL=https://<aqua-brain>.shuttleapp.app
   VITE_API_BASE_URL=/api

3. Restart the dashboard pointed at the cloud back-end:

   cd frontend
   npm run dev:prod

   Re-validate each challenge card to confirm remote success.

❓ FAQ

Q: Shuttle complains I’m not logged in.
A: Run shuttle login once (see “One-time Shuttle setup”).

Q: A port is already in use.
A: lsof -ti :<port> | xargs kill -9 frees it before re-running.

Q: The UI shows red banners / fetch errors.
A: Check that each backend terminal shows Listening on 0.0.0.0:PORT and that your .env* URLs match.

Q: Validation keeps failing even after I fixed the code.
A: Restart the corresponding service, then click Validate again; the validator inspects live code. When you validate a function, you can see more details about the validation results in shuttle logs (shuttle logs --latest). For example, if you validate the get_tank_readings function, you can see the following validation results in the logs:

Challenge validation check results request_id=f576a0f6-059b-464c-bddb-0205748e1418 uses_async_io=true no_blocking_operations=true has_proper_tracing=true

Q: How do I reset a service database?
A: Find the Docker container for the desired PostgreSQL database (there will be two databases serving ShellCon microservices), and delete it using docker rm -f <container_name>. Then restart the service using shuttle run --port <port>.

---

🩹 Troubleshooting cheat-sheet

• cargo check + cargo fmt before running.
• Runtime errors: shuttle logs --latest.
• Validation fails? Ensure the UI points to the right environment (localhost vs cloud).
• Port in use: lsof -ti :<port> | xargs kill -9.

---

🎓 What you’ll learn

• Async vs blocking I/O in Rust
• Writing efficient SQL with SQLx & Postgres
• Minimising heap allocations (Strings & Vec)
• Resource pooling & shared state with Axum
• Shuttle local dev → cloud deployment workflow

Good luck, Rustacean – the aquarium (and Ferris the crab 🦀) is counting on you!

Note: Any contribution to the project is welcome! Please open an issue or a pull request.