← All projects

Getting Started

Create a minimal Qwik City app.

Goal

This snapshot advances Beaconrock Digest by teaching you to create a minimal Qwik City app.

Every numbered folder is a complete app. Run this stage independently, then compare it with the previous folder.

Prerequisites

Use Node.js 20+, npm, and Docker for Postgres stages.

Port 3005 must be free. Copy .env.example before starting database stages.

  • Node.js and npm
  • A code editor and terminal
  • Docker from part 4 onward

Concepts

Qwik City boots a Vite SSR server with resumable components and file-based routes.

Keep the server boundary visible: routeLoader$ reads trusted data; routeAction$ validates input and re-checks authorization before mutations.

Walkthrough

Return a JSON hello from the root path.

Read the example, then open the matching snapshot. The repository includes the surrounding setup and error handling.

export const onGet: RequestHandler = async ({ json }) => {
  json(200, { message: 'Beaconrock Digest is live' })
}

Run and verify

Enter 01-Getting-Started, install dependencies, copy .env.example, and start Qwik City on port 3005.

Open http://127.0.0.1:3005. Watch the terminal for validation and database errors.

git clone https://github.com/michaeldunga1/fcc-qwik-blog.git
cd fcc-qwik-blog/01-Getting-Started
npm install
cp .env.example .env
npm run dev

Troubleshooting

If the browser cannot connect, confirm the process is still running.

For database failures, confirm Docker is running and the beaconrock_NN name matches the snapshot. Never commit .env or node_modules.

  • Read the first error first
  • Restart after environment changes
  • Never commit secrets

Try this

Add a /health route that returns JSON ok: true.

Test a happy path and one invalid or unauthorized request.

  • Make one small change
  • Test it in the browser
  • Compare with the next snapshot only after it works

Related tutorials