Skip to content

Is a web modern board application for sprint retrospective based in columns and cards.

License

Notifications You must be signed in to change notification settings

FredericoSFerreira/Open-Sprint-Retro

Repository files navigation

# Open sprint Retro Netlify Status

Open sprint Retro is a web modern board, open-source application for sprint retrospective based in columns and cards.


✨ Features

  • Management Boards: Create and management boards yours sprints.
  • Anonymous: Support anonymous user access your board.
  • Likes e Dislikes Cards: All users can vote in cards.
  • Hide Mode: The creator board can control hide cards in board for all user.

🚀 Technologies Used

Open sprint Retro is built using cutting-edge technologies to ensure both performance and developer productivity:




🛠️ Installation

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Customize configuration

See Vite Configuration Reference.

Project Setup Front

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint

Project Setup Backend

cd backend/
npm install

Up docker database

docker-compose up

Execute migrations

npm install -g migrate-mongo
npm run migrate

Start backend

npm run start

🤝 Contributing

We welcome contributions from the open-source community! Here's how you can get started:

  1. Fork the repository on GitHub.

  2. Clone your forked repo locally:

    git clone https://github.com/FredericoSFerreira/Open-Sprint-Retro.git or ssh [email protected]:FredericoSFerreira/Open-Sprint-Retro.git
  3. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name
  4. Make your changes, ensuring your code follows best practices.

  5. Test your changes locally to make sure everything works as expected.

  6. Commit and push your changes to your forked repository:

    git commit -m "Add feature: your-feature-name"
    git push origin feature/your-feature-name
  7. Submit a pull request to the main repository with a clear description of your changes.


🪐 Future Plans

  • Drag and Drop options
  • Implement multi-language, now suport only pt-br
  • Group and ungroup cards
  • Improve OTP login system
  • Implement comments in card

💬 Get in Touch

If you have any questions, feel free to reach out via GitHub Issues. We’d love to hear your thoughts or ideas for future improvements!


📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.