Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 25 additions & 21 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# Course Web App

## Getting Started
This Next.js app renders the root-level `s01_*` through `s20_*` course
chapters. The app does not treat `web/src/data/generated/*.json` or
`web/public/course-assets/` as source of truth; those files are generated from
the repository root.

First, run the development server:
## Local Development

```bash
npm ci
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
`npm run dev` runs `npm run extract` first, so edits to root chapter README
files, `code.py` files, or chapter SVG assets are copied into the web app
before the dev server starts.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## Updating Generated Course Data

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
After changing any root-level chapter content, run:

## Learn More

To learn more about Next.js, take a look at the following resources:
```bash
npm run extract
```

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
Commit the resulting updates under:

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
- `web/src/data/generated/`
- `web/public/course-assets/`

## Deploy on Vercel
This keeps the web course aligned with the canonical root chapters and prevents
the site from showing stale code signatures, line counts, documentation text, or
chapter diagrams.

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
## Production Build

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
```bash
npm run build
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion web/public/course-assets/s09_memory/memory-subsystems.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions web/src/data/generated/docs.json

Large diffs are not rendered by default.

375 changes: 219 additions & 156 deletions web/src/data/generated/versions.json

Large diffs are not rendered by default.