Go to file

Pijus Kamandulis 0c61c431f0 Validate on submit		2024-10-21 22:33:50 +03:00
functions	Allow user to set a username; Show list of users on estimation screen	2024-10-12 17:26:22 +03:00
public	Added icon and a Readme	2024-10-19 19:20:49 +03:00
src	Validate on submit	2024-10-21 22:33:50 +03:00
.env	Implement session invites	2024-10-12 00:04:36 +03:00
.gitignore	Code cleanup	2024-10-20 13:40:33 +03:00
.prettierrc	Added tailwind and style login screen	2024-10-06 16:52:39 +03:00
LICENSE	Initialize repository	2024-10-06 00:11:55 +03:00
README.md	Added icon and a Readme	2024-10-19 19:20:49 +03:00
appwrite.json	Allow user to set a username; Show list of users on estimation screen	2024-10-12 17:26:22 +03:00
bun.lockb	Allow user to import tickets from JIRA via CSV upload	2024-10-19 17:07:17 +03:00
eslint.config.js	Write a POC of estimation session	2024-10-06 15:15:36 +03:00
index.html	Added icon and a Readme	2024-10-19 19:20:49 +03:00
package.json	Allow user to import tickets from JIRA via CSV upload	2024-10-19 17:07:17 +03:00
postcss.config.js	Added tailwind and style login screen	2024-10-06 16:52:39 +03:00
tailwind.config.js	Style estimation session list	2024-10-06 17:31:02 +03:00
tsconfig.app.json	Code cleanup	2024-10-20 13:40:33 +03:00
tsconfig.json	Initialize repository	2024-10-06 00:11:55 +03:00
tsconfig.node.json	Initialize repository	2024-10-06 00:11:55 +03:00
vite.config.ts	Code cleanup	2024-10-20 13:40:33 +03:00

README.md

Scrummie-Poker

Scrummie-Poker is a collaborative estimation tool for agile teams, designed to simplify story point estimation through a modern and intuitive interface.

Features
Tech Stack
Setup Instructions
Contributing
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)

Clone the Repository

git clone https://github.com/pikami/scrummie-poker.git
cd scrummie-poker

Install Dependencies

npm install

Set Up Environment Variables

Create a .env file in the root directory and add your Appwrite project credentials:

VITE_APPWRITE_ENDPOINT=https://<YOUR_APPWRITE_ENDPOINT>
VITE_APPWRITE_PROJECT_ID=<YOUR_PROJECT_ID>
VITE_APPWRITE_DATABASE_ID=<YOUR_DATABASE_ID>
VITE_APPWRITE_ESTIMATION_SESSION_COLLECTION_ID=<YOUR_ESTIMATION_SESSION_COLLECTION_ID>
VITE_SESSION_INVITE_FUNCTION_ID=<YOUR_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:

Fork the repository.
Create a new branch for your feature or fix.
Make your changes and commit them.
Push your changes to your forked repository.
Open a pull request.

License

This project is MIT licensed.