Getting Started

Goal

This snapshot advances Canopy Journal by teaching you to create a minimal AdonisJS app on port 3002.

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. You should recognize async functions and HTTP verbs.

Port 3002 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

Adonis boots an HTTP server with controllers and the IoC container.

Keep controllers thin: routes accept input, Lucid models enforce rules, and Edge escapes output by default.

Walkthrough

Register a root route that returns JSON and listen on port 3002.

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

router.get('/', (req, res) => res.json({ message: 'Canopy Journal is live' }))

Run and verify

Enter 01-Getting-Started, install dependencies, copy .env.example when present, and start Ace on port 3002.

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

git clone https://github.com/michaeldunga1/fcc-adonis-blog.git
cd fcc-adonis-blog/01-Getting-Started
npm install
cp .env.example .env
node ace serve --watch

Troubleshooting

If the browser cannot connect, confirm Ace is still running. EADDRINUSE means another process owns 3002.

For database failures, confirm Docker and the canopy_NN name when applicable. 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