Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hildegarmedina/planning-poker

A collaborative tool for agile teams to estimate project tasks using the Planning Poker technique. This application leverages Socket.IO for real-time communication and Redis for efficient caching, ensuring a seamless and responsive user experience.
https://github.com/hildegarmedina/planning-poker

ejs expressjs nodejs planning-poker planning-poker-game socket-io

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/hildegarmedina/planning-poker
Owner: HildegarMedina
Created: 2024-10-08T13:35:10.000Z (28 days ago)
Default Branch: develop
Last Pushed: 2024-10-30T23:21:36.000Z (6 days ago)
Last Synced: 2024-10-31T00:19:45.880Z (6 days ago)
Topics: ejs, expressjs, nodejs, planning-poker, planning-poker-game, socket-io
Language: EJS
Homepage:
Size: 105 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Planning Poker

# Technologies Used in the Project

## 🚀 Main Technologies

| Technology | Description |
|--------------|-----------------------------------------------------------|
| **Express.js** | Express is a lightweight and flexible routing framework with minimal core features. |
| **Socket.io** | Bidirectional and low-latency communication for every platform. |
| **Bulma** | Bulma is a free, open source CSS framework based on Flexbox and built with Sass. |
| **Redis** | Redis is an open source data structure server. |
| **Chart.js** | Chart.js renders chart elements on an HTML5 canvas. |

## Setup with Docker
```
docker-compose up
```

## Setup without Docker

You need to copy and paste the file named .env.example:
```
cp .env.example .env
```

Install the dependencies:
```
npm install or yarn
```

### Run App

Start the app:
```
yarn dev or npm run dev
```

## Project Directory Structure

```
├── src # App Folder
│ ├── controllers # Interface client - services
│ ├── routes # Routes of application
│ ├── services # Business logic layer of the application
│ ├── sockets # Handlers and connection socket
│ ├── views # Views of application
├── cache # Config cache redis
├── public # Static files
└── app.py # Main script of project
```

## Contributing

We welcome contributions from the community! To contribute to the Planning Poker project, please follow these steps:

1. **Fork the Repository**: Click on the “Fork” button at the top right corner of the repository page to create a personal copy of the project in your GitHub account.

2. **Clone the Forked Repository**: Clone your forked repository to your local machine using the following command:
```
git clone https://github.com/your-username/planning-poker.git
```

3. **Create a New Branch**: Navigate into the project directory and create a new branch for your feature or bug fix. Use a descriptive name that reflects the task you are working on:
```
git checkout -b feature/name-task
```

4. **Make Your Changes**: Implement your changes in the code. Make sure to test your changes thoroughly to ensure everything works as expected.

5. **Commit Your Changes**: Once you are satisfied with your modifications, commit them with a clear and concise message describing the changes you made.
```
git add .
git commit -m "Add feature: description of the feature"
```

6. **Push to Your Fork**: Push your changes to your forked repository
```
git push origin feature/name-task
```

7. **Open a Pull Request (PR)**: Go to the original repository where you want to contribute. Click on the “Pull Requests” tab, then click on the “New Pull Request” button. Select your branch from the dropdown and create the pull request. Provide a detailed description of the changes you made and why they should be merged.