Look at the Nuxt 3 documentation to learn more.

This project is licensed under the terms of the GNU Affero General Public License Version 3 or later.

You can use the devbox bundler for the bun-bundler.

1. Install Devbox
2. Run devbox run dev to start the server listening at http://localhost:3000

This also installs pre-commit, so you can use the following to commit your code:

devbox run git commit -am "your messge"

This will run the pre-commit hooks defined by husky.

If prettier complains that one or more of your files don't follow its formatting, you can update all the files like this:

devbox run prettier

Make sure to install the dependencies:

# bun
bun install

Start the development server on http://localhost:3000:

# bun
bun run dev

If you do any changes to any of the schemas, make sure to run this command

bunx json2ts utils/schemas -o ./types

If you have never used Playwright before, you need to run bun playwright install to install the browsers Playwright uses for testing. If your system does not meet the Playwright's system requirements, you need to run it with the --with-deps flag (requires administrator privileges).

To run Playwright, either run

bun playwright:test [file]
devbox run playwright:test [file]

(with file for a specific file, or without to run all) to run it in the command-line, or

bun playwright:test-ui
devbox run playwright:test-ui

to run it in a GUI.

If you're running Playwright on macOS, the command-line tests are currently flaky, but running in a GUI seems to yield consistent results.

Build the application for production:

# bun
bun run build

Locally preview production build:

# bun
bun run preview

Check out the deployment documentation for more information.

The CI builds and pushes a Docker image to ghcr.io/c4dt/showcase_v2. If you want to run it locally, either pull it from there, or build it yourself

docker build -t ghcr.io/c4dt/showcase_v2:<X.Y> .

and then run it

docker run --rm -p 127.0.0.1:3000:80 ghcr.io/c4dt/showcase_v2:<X.Y>