Skip to content

README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicholasdly merged 1 commit into from
Sep 17, 2025
Merged

README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# spacedleetcode

> A spaced repetition system for effectively studying popular technical interview problems.

## Features

- Vite + TypeScript + SWC
- Tailwind CSS + shadcn/ui
- IndexedDB + Dexie.js
- Prettier + ESLint

## Getting Started

There aren't many _mandatory_ prerequisites other than **npm**.

1. Download, fork, or template this repository.
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:

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

## License

Licensed under the [MIT License](LICENSE), Copyright © 2025