Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ jobs:

- name: Formatting
run: npm run format:check

- name: Tests
run: npm run test
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
- Vite + TypeScript + SWC
- Tailwind CSS + shadcn/ui
- IndexedDB + Dexie.js
- Prettier + ESLint
- ESLint + Prettier
- Vitest

## Getting Started

Expand All @@ -17,11 +18,12 @@ There aren't many _mandatory_ prerequisites other than **npm**.
2. Download dependencies via `npm i`.
3. Start a local development server via `npm run dev`.

Before making a contribution, be sure to run the typechecker and linter:
Before making a contribution, be sure to run the following scripts:

1. Run a typecheck via `npm run typecheck`.
2. Run ESLint via `npm run lint`.
3. Run Prettier via `npm run format`.
4. Run Vitest via `npm run test`.

## License

Expand Down
Loading