cr8s-fe 🎨

Yew/WASM frontend companion to the cr8s Rust backend. Built with ⚡ hot‑reload via Trunk, stateful components, and a clean Tailwind‑free CSS layer (see style.scss).

---

Prerequisites

• Docker ≥ 24 & Docker Compose v2, Rust 1.88.0 or newer

Note: The development environment automatically handles user permissions across different systems (local dev, CI, contributors) using containerized tooling.

---

Quick Start

Before running the container, ensure you are authenticated with GitHub Container Registry.
See Docker Login with PAT for instructions on creating a GitHub Personal Access Token (PAT) and logging in to ghcr.io.

cargo build -p quickstart
target/debug/quickstart start --lint basic

This launches the full stack:

• Starts PostgreSQL, Redis, and cr8s backend
• Loads database schema and default roles
• Creates test user: [email protected] / password123 (with admin, editor, viewer roles)
• Launches the frontend with hot reload on http://localhost:8080

🐳 Requires Docker ≥ 24 and Docker Compose v2

Open http://localhost:8080; edits you make in src/** will hot‑reload in ~1 s.

🧼 Stopping Services

To stop all services and remove containers and volumes:

target/debug/quickstart shutdown

Note: this also removes database volumes — login data will be reset. for volume mounts, CI integration, and multi-service workflow. 💡 Prefer Docker? See dev-container-usage.md

Development Workflow

Configuration:

• Backend version is controlled by cli/src/main.rs, search for CR8S_VERSION in this file to see current version.

fn get_cr8s_version() -> String {
    // This is the version of cr8s BE that we are targeting.
    get_env_with_default("CR8S_VERSION", "0.5.1")
}

• See dev-container-usage.md for up-to-date instructions on using the containerized development environment. This includes lint checks, image builds, volume reuse, and CI integration.
• Frontend source code mounted for hot reload development
• Database persists between restarts (until shutdown.sh runs)

---

Heads-up: When the container starts, Docker Compose may print

Enable Watch → watch is not yet configured.

This is Compose's optional file-watch feature. You don't need it—
Trunk inside the container already hot-reloads on src/** changes.
Simply ignore the prompt (don't type w) and keep coding.

See hot-reload in action 

1. Open src/components/login_form.rs.
2. Find the line that renders the username field:

   <Input label="Username" ... />

3. Change "Username" to "Enter your username" and save.
4. Watch the Docker/Trunk terminal — a quick re-compile appears.
5. Switch back to the browser (still on /login) — the placeholder now reads Enter your username without a manual refresh.

Revert the text and save again to watch it snap back.

---

🔒 Backend Login Test (Manual Smoke Test)

Once the frontend & backend are running

1. If you haven't already, open your browser to http://127.0.0.1:8080

2. Enter the default credentials:

   Username: [email protected]
   Password: password123
   

3. ✅ You should see the authenticated view (e.g. "Have a great day!")

4. Feel free to try out the APIs.
   a) Click on Rustaceans
   b) Click on "Add a new rustacean"
   c) Enter some test values and press save
   d) Click on Crates
   e) Add a new crate
   

---

🧪 End-to-End Testing

E2E tests run by default in CI. To run them manually see the full instructions in docs/manual-e2e-tests.md.

Note: E2E tests can be disabled in CI via workflow_dispatch with run_e2e=false.

---

Continuous Integration

Every push & PR runs quickstart → lint checks → build → E2E tests via .github/workflows/ci.yml. The CI includes configurable lint levels and comprehensive testing across multiple browsers.

⚡ Performance: CI builds complete in under 4 minutes with optimized container operations and streamlined permission handling.

---

Project Structure

cr8s-fe/
├── Cargo.toml
├── README.md
├── CHANGELOG.md
├── cli
│   ├── Cargo.toml
│   └── src
│       └── main.rs
├── docs/
│   ├── dev-container-usage.md
│   └── manual-e2e-tests.md     # E2E instructions for local dev
├── index.html                  # App entrypoint
├── src/
│   ├── api/                    # REST/GraphQL helpers
│   ├── components/             # Reusable Yew components
│   ├── pages/                  # Top-level routes
│   ├── contexts.rs             # Global state providers
│   ├── hooks.rs                # Custom hooks
│   └── main.rs                 # Yew entrypoint & router
├── style.scss
├── tests/
│   └── playwright/             # E2E browser tests (Playwright)
├── Dockerfile.fe-server        # Dockerfile to build cr8s-fe-server
└── docker-compose.yml          # Full-stack container definition

---

Related Projects

Project	What it shows off
cr8s	Rocket + Postgres backend that powers this UI
axum-quickstart	Production-ready REST API using Axum, Redis, and Tokio
rust-sqlx	Async Postgres examples leveraging SQLx enum mapping

---

Development

See Dev-container-usage.md for full details on container-based development, including linting, volume mounts, and usage of the quickstart CLI.

---

License

This project is dual-licensed under MIT OR Apache-2.0. See LICENSE-MIT and LICENSE-APACHE for details.