From a1fe58d7b91fa98a96c00015c1b01a76e1f09652 Mon Sep 17 00:00:00 2001 From: Nicholas Ly Date: Wed, 17 Sep 2025 18:51:04 -0500 Subject: [PATCH] README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d44fd10 --- /dev/null +++ b/README.md @@ -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