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

https://github.com/fredericosferreira/kanban-flex

Is a web modern kanban board trello alternative application based in columns and cards.
https://github.com/fredericosferreira/kanban-flex

board kanban kanban-board-application retro sprint trello

Last synced: 3 months ago
JSON representation

Is a web modern kanban board trello alternative application based in columns and cards.

Awesome Lists containing this project

README

          

# # KanbanFlex [![Netlify Status](https://api.netlify.com/api/v1/badges/08200383-b16d-4391-a914-37fe41309b3c/deploy-status)](https://app.netlify.com/sites/open-sprint-retro/deploys) [![codecov](https://codecov.io/gh/FredericoSFerreira/kanban-flex/branch/main/graph/badge.svg?flag=backend)](https://codecov.io/gh/FredericoSFerreira/kanban-flex) [![Backend Tests and Coverage](https://github.com/FredericoSFerreira/kanban-flex/actions/workflows/tests.yml/badge.svg)](https://github.com/FredericoSFerreira/kanban-flex/actions/workflows/tests.yml)

[**KanbanFlex**](https://kanbanflex.com/) is a web modern board, open-source application 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

KanbanFlex 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](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.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](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.

## Customize configuration

See [Vite Configuration Reference](https://vite.dev/config/).

## Project Setup Front

```sh
npm install
```

### Compile and Hot-Reload for Development

```sh
npm run dev
```

### Type-Check, Compile and Minify for Production

```sh
npm run build
```

### Run Unit Tests with [Vitest](https://vitest.dev/)

```sh
npm run test:unit
```

### Lint with [ESLint](https://eslint.org/)

```sh
npm run lint

```

## Project Setup Backend

```sh
cd backend/
npm install
```

## Up docker database

```sh
docker-compose up
```

### Execute migrations

```sh
npm install -g migrate-mongo
npm run migrate
```

### Start backend

```sh
npm run start
```

### Run Tests

```sh
# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests in watch mode
npm run test:watch

# Run only unit tests
npm run test:unit

# Run only e2e tests
npm run test:e2e
```

Execute os testes antes de enviar um PR para garantir que suas alterações não quebrem funcionalidades existentes.

## 🤝 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:

```bash
git clone https://github.com/FredericoSFerreira/kanban-flex.git or ssh git@github.com:FredericoSFerreira/Open-Sprint-Retro.git
```

3. **Create a new branch** for your feature or bug fix:

```bash
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:

```bash
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

- Group and ungroup cards
- New integrations

---

## 💬 Get in Touch

If you have any questions, feel free to reach out via [GitHub Issues](https://github.com/FredericoSFerreira/kanban-flex/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](./LICENSE) file for more details.