98 lines
2.6 KiB
Markdown
98 lines
2.6 KiB
Markdown
# portfolio
|
|
|
|
This template should help get you started developing with Vue 3 in Vite.
|
|
|
|
## Recommended IDE Setup
|
|
|
|
[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
|
|
|
|
## Recommended Browser Setup
|
|
|
|
- Chromium-based browsers (Chrome, Edge, Brave, etc.):
|
|
- [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
|
|
- [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
|
|
- Firefox:
|
|
- [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
|
|
- [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
|
|
|
|
## Type Support for `.vue` Imports in TS
|
|
|
|
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
|
|
|
|
## Customize configuration
|
|
|
|
See [Vite Configuration Reference](https://vite.dev/config/).
|
|
|
|
## Project Setup
|
|
|
|
```sh
|
|
bun install
|
|
```
|
|
|
|
### Compile and Hot-Reload for Development
|
|
|
|
```sh
|
|
bun dev
|
|
```
|
|
|
|
### Type-Check, Compile and Minify for Production
|
|
|
|
```sh
|
|
bun run build
|
|
```
|
|
|
|
### Run Unit Tests with [Vitest](https://vitest.dev/)
|
|
|
|
```sh
|
|
bun test:unit
|
|
```
|
|
|
|
### Run End-to-End Tests with [Playwright](https://playwright.dev)
|
|
|
|
```sh
|
|
# Install browsers for the first run
|
|
npx playwright install
|
|
|
|
# When testing on CI, must build the project first
|
|
bun run build
|
|
|
|
# Runs the end-to-end tests
|
|
bun test:e2e
|
|
# Runs the tests only on Chromium
|
|
bun test:e2e --project=chromium
|
|
# Runs the tests of a specific file
|
|
bun test:e2e tests/example.spec.ts
|
|
# Runs the tests in debug mode
|
|
bun test:e2e --debug
|
|
```
|
|
|
|
### Lint with [ESLint](https://eslint.org/)
|
|
|
|
```sh
|
|
bun lint
|
|
```
|
|
|
|
## Docker
|
|
|
|
The Dockerfile serves a pre-built `dist/` directory via nginx, so build the
|
|
app first:
|
|
|
|
```sh
|
|
bun run build
|
|
docker build -t portfolio .
|
|
docker run --rm -p 8080:80 portfolio
|
|
```
|
|
|
|
The site will be available at http://localhost:8080.
|
|
|
|
### CI publishing
|
|
|
|
A Forgejo Actions workflow (`.forgejo/workflows/docker-publish.yml`) builds the
|
|
image and pushes it to the Forgejo container registry whenever a `v*` tag is
|
|
pushed (e.g. `v1.2.3`):
|
|
|
|
- `git.mcpeakdev.com/mcpeakml/portfolio:<version>`
|
|
- `git.mcpeakdev.com/mcpeakml/portfolio:latest`
|
|
|
|
This requires a `REGISTRY_TOKEN` repository secret containing a token with
|
|
`write:package` permission for the registry.
|