Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mitsunee/mitsu-portfolio

Repository for Mitsunee's Portfolio site - written with Astro & Preact
https://github.com/mitsunee/mitsu-portfolio

astrojs portfolio-website preact

Last synced: about 5 hours ago
JSON representation

Repository for Mitsunee's Portfolio site - written with Astro & Preact

Awesome Lists containing this project

README

        

# Mitsunee


Mitsunee

Repository for https://www.mitsunee.com

## Development Setup

This project uses [Astro] with [Preact] for interactive components.

Make sure you have [node.js] (version 18 or higher) and [pnpm] (version 8) installed. Install all dependencies and start the Development server:

```shell
pnpm install
./scripts/install-sharp.sh
pnpm dev
```

There are git hooks in place to format all staged files prior to committing. Please run `pnpm lint` prior to committing if your editor does not integrate ESLint. Github Actions will check formatting, lint and check types on each push.

## Testing

These are the same commands also run in CI on every push:

```shell
pnpm lint:strict
pnpm format:check
pnpm typecheck
```

Full list of commands

```shell
pnpm format # formats entire codebase
pnpm format:check # checks formatting on entire codebase
pnpm lint # standard lint check on entire codebase
pnpm lint:fix # standard lint check on entire codebase with autofix enabled
pnpm lint:strict # strict lint check on entire codebase
pnpm dev # start dev server
pnpm typecheck # run typechecks on entire codebase
pnpm build:types # generates content/data collection types
pnpm build # create production build
```

## Production build

Simply run the build script:

```shell
pnpm build
```

To test a production build locally either use `pnpm astro preview` or [binserve](https://github.com/mufeedvh/binserve) with the provided configuration.

[astro]: https://docs.astro.build/en/getting-started/
[preact]: https://preactjs.com/guide/v10/getting-started
[node.js]: https://nodejs.org/en/
[pnpm]: https://pnpm.io/