+
+Scrummie-Poker is a collaborative estimation tool for agile teams, designed to simplify story point estimation through a modern and intuitive interface.
+
+## Table of Contents
+
+- [Features](#features)
+- [Tech Stack](#tech-stack)
+- [Setup Instructions](#setup-instructions)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- Create and manage estimation sessions
+- Invite team members to join sessions
+- Create or import tickets for estimation
+- Real-time voting on ticket estimates
+- User authentication and guest access
+
+## Tech Stack
+
+- **Frontend:** React, Vite
+ - **Libraries:**
+ - tanstack router (app routing)
+ - tanstack forms (form state management)
+ - yup (for validation)
+ - tailwindcss (for styling)
+ - ckeditor5 (for rich text editing)
+ - papaparse (for CSV ticket import)
+ - showdown (for markdown conversion)
+- **Backend:** Appwrite
+ - **Capabilities:**
+ - Auth (user management)
+ - Databases (session and ticket storage)
+ - Realtime API (live updates)
+ - Functions (session invitations and username updates)
+
+## Setup Instructions
+
+### Prerequisites
+
+- Node.js (version 20 or later) or Bun
+- Appwrite account and project setup (see [Appwrite Documentation](https://appwrite.io/docs))
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/pikami/scrummie-poker.git
+cd scrummie-poker
+```
+
+### Install Dependencies
+
+```bash
+npm install
+```
+
+### Set Up Environment Variables
+
+Create a `.env` file in the root directory and add your Appwrite project credentials:
+
+```
+VITE_APPWRITE_ENDPOINT=https://
+VITE_APPWRITE_PROJECT_ID=
+VITE_APPWRITE_DATABASE_ID=
+VITE_APPWRITE_ESTIMATION_SESSION_COLLECTION_ID=
+VITE_SESSION_INVITE_FUNCTION_ID=
+```
+
+### Start the Development Server
+
+`npm run dev` or `bun run dev`
+
+Your app should now be running on http://localhost:5173.
+
+# Contributing
+
+Contributions are welcome! If you'd like to contribute to Scrummie-Poker, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or fix.
+3. Make your changes and commit them.
+4. Push your changes to your forked repository.
+5. Open a pull request.
+
+# License
+
+This project is [MIT licensed](./LICENSE).
diff --git a/index.html b/index.html
index e4b78ea..ce1c8d5 100644
--- a/index.html
+++ b/index.html
@@ -2,9 +2,9 @@
-
+
- Vite + React + TS
+ Scrummie Poker
diff --git a/public/icon.svg b/public/icon.svg
new file mode 100644
index 0000000..1235127
--- /dev/null
+++ b/public/icon.svg
@@ -0,0 +1,13 @@
+
+
diff --git a/src/components/Header.tsx b/src/components/Header.tsx
index 41dbff9..737ce27 100644
--- a/src/components/Header.tsx
+++ b/src/components/Header.tsx
@@ -26,9 +26,9 @@ const Header = () => {
+
Scrummie-Poker