Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 3.42 KB

README.md

File metadata and controls

109 lines (71 loc) · 3.42 KB

OpenSSF Scorecard

Gurubu

License

Live demo 👉 https://gurubu.vercel.app/

Simple, Fast, and Practical Task Estimation and Score Card Grooming

Agree with your teammates quickly and reliably! Start by setting up a room.

GuruBu How To

Gurubu is a tool designed to streamline task estimation grooming sessions and prioritize tasks using a room-based, user-friendly approach. With a single click, users can create a room, invite team members, and start estimating story points or voting on multiple metrics for score card grooming.

GuruBu Home

Features

  • One-Click Room Setup: Quickly create a dedicated room for your task estimation or score card grooming session.
GuruBu Setup

  • User-Friendly Interface: Easily enter your name and join a room, making collaboration simple and efficient.

  • Story Point Estimation: Streamline the process of estimating story points to better plan and manage your project.

  • Score Card Grooming: Prioritize tasks effectively by allowing users to vote on multiple metrics.

GuruBu Score Card
  • Jira Issue Importer: Import your Jira issues
GuruBu Jira Import

Getting Started

Requirements

  • Node.js and yarn (To manage project dependencies for the frontend and the backend)

Root Installation

  • Run yarn at the root of the project to install git hooks.

Frontend Installation

  1. Clone this repository to your local machine:
https://github.com/Trendyol/gurubu.git
  1. Navigate to the frontend directory:
cd gurubu-client
  1. Create .env variable root of the project and add this variable:
NEXT_PUBLIC_API_URL="http://localhost:5000"
  1. Install the dependencies:
yarn
  1. Start the frontend application:
yarn dev

The frontend application should now be running at http://localhost:3000.

Backend Installation

  1. Clone this repository to your local machine:
https://github.com/Trendyol/gurubu.git
  1. Navigate to the backend directory:
cd gurubu-backend
  1. Create .env variable root of the project and add this variable:
CLIENT_URL="http://localhost:3000"
  1. Install the dependencies:
yarn
  1. Start the backend application:
yarn start

The backend server should now be running at http://localhost:5000.

Contributing

We welcome and appreciate contributions from the community. Whether it's reporting issues, suggesting improvements, or submitting code, your help is valuable. Thank you for being a part of our project!

External License

This project uses DiceBear for avatar generation. DiceBear is licensed under the MIT License.