DocsUnit 1: the basics
Build a notes app with Nexy, part 1: create the project
Part 1 of the tutorial creates the project you will grow into a notes app, and runs it in your browser in about five minutes.
Before you start: uv and Node.js 20 or newer. The tutorial follows the router chosen at the top of the menu: switch it there and every part shows that router's files.
What you will build
By the end of the tutorial, the app has pages and a JSON API for notes, a database, accounts, notes shared by email, live updates, tests, and a production build. Each part ends with an app that runs, so you can stop after any of them.
Create the project
uvx nexy new notesAnswer the questions this way:
| Question | Answer |
|---|---|
| File-based router? | Yes for the file-based and custom routers, No for the modular one |
| Project type | Web |
| Client-side routing | No: the server renders the pages |
| Client framework | React: it comes back in unit 4, for islands |
| Style | Tailwind CSS |
| Import alias | @ |
| ORM | No database: part 5 adds one |
The custom router is the file-based one plus an APIRouter you already have. The tutorial builds
the app with files; Include an existing FastAPI router shows how to
mount yours next to them.
Run it
cd notessource .venv/bin/activate # Windows: .venv\Scripts\activatenexy devOpen http://localhost:3000. You should see the welcome page. Leave nexy dev running: from now
on, every file you save reloads the browser.
What you learned
uvx nexy newcreates a project and installs its Python and JavaScript packages.nexy devserves it and reloads on save.
- The pages live in
src/routes/: the next part adds one.
- The controllers and their views live in
src/apps/: the next part adds one.
Next steps
- Part 2: pages and layouts
- Project structure: what each file of the project is for