docs: rewrite README for apoena.dev

This commit is contained in:
Julien Calixte
2026-05-23 16:12:56 +02:00
parent aa36e00576
commit 71ad6bbc2e

View File

@@ -1,50 +1,20 @@
# blog # apoena.dev
[îles]: https://github.com/ElMassimo/iles Julien Calixte's blog, built with [îles](https://github.com/ElMassimo/iles).
[configuration reference]: https://iles-docs.netlify.app/config
This template should help get you started developing with [îles]. Live at [apoena.dev](https://apoena.dev).
## Recommended IDE Setup ## Requirements
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). - Node.js >= 22
- pnpm 10
## Type Support for `.vue` Imports in TS ## Scripts
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic `PageComponent` type by default. In most cases this is fine if you don't really care about component prop types outside of templates.
However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette.
## Customize configuration
See îles [Configuration Reference].
## Project Setup
```sh ```sh
npm install pnpm install # install dependencies
``` pnpm dev # start the dev server
pnpm build # build for production
### Compile and Hot-Reload for Development pnpm preview # preview the production build on port 5050
pnpm typecheck # run vue-tsc
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Cypress Component Testing](https://docs.cypress.io/guides/component-testing/introduction)
```sh
npm run test:unit # or `npm run test:unit:ci` for headless testing
```
### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
```sh
npm run test:e2e # or `npm run test:e2e:ci` for headless testing
``` ```