jplukas / BrieflyPlanningPoker

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Briefly Planning Poker

All Contributors

Briefly planning poker is an online Planning Poker/Scrum Poker tool that lets you estimate effort, time of development and other characteristics of your agile team tasks. In it, you can:

  • Create and manage agile squads
  • Create or import tasks, or user stories from other project management tools (soon)
  • Comment on and estimate different task measures such as story points, likeability, and etc in your product backlog (soon)
  • Integrate with other platforms to make your sprint planning sessions easier (soon)

Tech Stack

This project is composed by a front end SPA and a REST API server. The entire stack uses Typescript as the programming language, in order to provide type-safety, IDE intellisense autocompletion and some other features to promote a better developer experience.
Furthermore, this is our tech stack:

Repository structure

The project is organized as a monorepo. It is subdivided in a bunch of different workspaces, that can be found at the packages folder.

  • @briefly/prisma
    The projects data models definitions and data access client. Uses the Prisma ORM to enable having a unique source of truth, as well as a source for run-time validation, using Zod.

  • @briefly/apidef
    The projects API definitions. Establishes an interface between the front and back end of the application.
    Uses Zod and Zodios.

  • @briefly/api
    The projects back end, written using Express.

  • @briefly/front
    The projects front-end application, written in Vue.

Dependencies

Installation and usage

Getting help

Contributions

Do you have a suggestion to improve this project somehow? Feel free to open an issue, or submit a PR.
The contribution guide can be accessed here

Development

To run the entire application (front-end, back-end and database): docker compose up front
This command will create a new postgreSQL database using .env variables to set up password, username and database name, and then start the REST API and front end servers.

To run only the back end: docker compose up api
This command will create a new postgreSQL database using .env variables to set up password, username and database name. Also runs all migrations and seeds scripts (./packages/store/db/migrations), and finally starts api.

To run only database: docker compose up db
This command will create a new postgreSQL database using .env variables to set up password, username and database name.

Development workflow

Contributors ✨

Thanks goes to these wonderful people (emoji key):

João Pedro Lukasavicus
João Pedro Lukasavicus

💻
lucca jacomassi
lucca jacomassi

💻
Igor
Igor

💻
Rafael Henrique Siqueira Silva
Rafael Henrique Siqueira Silva

💻
Ingrid Pacheco Batista
Ingrid Pacheco Batista

💻
bachiari
bachiari

💻
Aline Conquista
Aline Conquista

💻
Leandro Trovões
Leandro Trovões

💻
Thiago Henrique
Thiago Henrique

💻
Will0890
Will0890

💻
isamaues
isamaues

📆 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!

About

License:GNU General Public License v3.0


Languages

Language:TypeScript 63.8%Language:Vue 33.0%Language:HTML 1.3%Language:SCSS 1.1%Language:Dockerfile 0.4%Language:JavaScript 0.2%Language:Shell 0.1%Language:Makefile 0.1%Language:Procfile 0.0%