Skip to content

Commit b8f3e32

Browse files
committed
readme update
1 parent 601a065 commit b8f3e32

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

template/README.md.jinja

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
{% raw %}[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
2-
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](https://github.com/copier-org/copier)
3-
[![Actions status](https://www.github.com/LabAutomationAndScreening/copier-nuxt-python-intranet-app/actions/workflows/ci.yaml/badge.svg?branch=main)](https://www.github.com/LabAutomationAndScreening/copier-nuxt-python-intranet-app/actions)
4-
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://www.github.com/LabAutomationAndScreening/copier-nuxt-python-intranet-app)
2+
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://www.github.com/{% endraw %}{{ repo_org_name }}{% raw %}/{% endraw %}{{ repo_name }}{% raw %})
53

64

7-
# Usage
8-
To create a new repository using this template:
9-
1. Install `copier` and `copier-templates-extensions`. An easy way to do that is to copy the `.devcontainer/install-ci-tooling.sh` script in this repository into your new repo and then run it.
10-
2. Run copier to instantiate the template: `copier copy --trust gh:LabAutomationAndScreening/copier-nuxt-python-intranet-app.git`
11-
3. Run `uv lock` to generate the lock file
12-
4. Commit the changes
13-
5. Rebuild your new devcontainer
145

6+
# Development
157

8+
## Frontend
9+
Start the development server on `http://localhost:3000`:
10+
```bash
11+
pnpm run --dir=frontend dev
12+
```
1613

17-
# Development
14+
Build the application for production:
15+
16+
```bash
17+
pnpm run --dir=frontend build
18+
```
1819

19-
## Initializing Nuxt for the app
20-
At the root of the repo, run `pnpm dlx nuxi@latest init frontend`
21-
Select "overwrite directory", `pnpm` and do not initialize git repository.
22-
You can remove the extra .gitignore file `rm frontend/.gitignore`
20+
Locally preview production build:
21+
```bash
22+
pnpm run --dir=frontend preview
23+
```
2324

2425
## Updating from the template
2526
This repository uses a copier template. To pull in the latest updates from the template, use the command:

0 commit comments

Comments
 (0)