initial

project.md

@@ -0,0 +1,29 @@
+# marathon.todo
+
+A web application that allows users to create a to-do list of what to loot (or do) in raid in Bungie's Marathon video game.
+
+## Tech Stack
+- React
+- TypeScript
+- Frontend-only
+
+## Data Source
+https://marathondb.gg/ provides a public API with all the necessary game data.
+
+The `app.js` file downloaded from this site can be used to generate a TypeScript client for the API.
+
+## Project Rules
+- Save all added features and changes (except very minor ones) to the `CHANGELOG.md` file.
+- Always update the `README.md` file accordingly.
+
+## Initial Features
+- User can search for an item by name.
+- Search results display up to 5 relevant items with their icons.
+- User can add an item to the to-do list by clicking on it.
+- User can specify the quantity for each added item.
+- User can mark items as completed.
+- User can delete items from the to-do list.
+
+## UI
+- Keep the UI very simple for now.
+- Minimal styling.