This is a project built with Next.js and TypeScript that allows teams to estimate the relative size of their backlog items using Planning Poker.
To get started with this project, follow these steps:
- Clone the repository to your local machine using
git clone https://github.com/RuanAragao/planpoker.git
- Install the dependencies using
yarn install
- Set up a Firebase project and Firestore database (see instructions below)
- Add the Firebase configuration to the project (see instructions below)
- Start the development server using
yarn dev
- Open http://localhost:3000 in your browser to see the app
To set up a Firebase project and Firestore database for this project, follow these steps:
- Go to the Firebase console and create a new project
- Click on "Firestore Database" in the sidebar and create a new database
- In the "Rules" tab of your database, replace the default rules with the following:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if request.auth != null;
}
}
}
- Click on the gear icon next to "Project Overview" in the sidebar and select "Project settings"
- Scroll down to the "Firebase SDK snippet" section and select "Config"
- Copy the object that appears, which should look something like this:
{
apiKey: "your-api-key",
authDomain: "your-auth-domain",
databaseURL: "your-database-url",
projectId: "your-project-id",
storageBucket: "your-storage-bucket",
messagingSenderId: "your-messaging-sender-id",
appId: "your-app-id"
}
- Create a new file in the root of your project called
.env.local
and add the following lines, replacing the values with your Firebase project's config values:
NEXT_PUBLIC_FIREBASE_API_KEY=your-api-key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your-auth-domain
NEXT_PUBLIC_FIREBASE_DATABASE_URL=your-database-url
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your-storage-bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your-messaging-sender-id
NEXT_PUBLIC_FIREBASE_APP_ID=your-app-id
- Next.js - The React framework used
- TypeScript - The programming language used
- Firebase Firestore - The cloud database used
- Tailwind CSS - The UI library used
Contributions are always welcome! If you'd like to contribute, please see CONTRIBUTING.
This project is licensed under the MIT License. See the LICENSE file for details.