Easily create Kanbans in a moment.
Canbemini is an easy-to-use tool for creating Kanbans in a moment. With a simple user interface, you can quickly set up and configure your Kanbans for different process flows. Canbemini also allows for shared access and manipulation of notes by multiple users, as well as control of access and sharing with coworkers. In addition to these key features, Canbemini offers swimlanes for state management, attachments to notes, and shared roles such as owner, editor, and viewer. Try Canbemini now to streamline your workflows and improve collaboration with your team.
- Easy creation and configuration of Kanbans with a simple user interface.
- Shared access to Kanbans with other users and manipulation of notes (text cards) by all users.
- Control of access to Kanbans and sharing with coworkers to work privately with a selected group of people.
- Attachments to each note to add additional information.
- Shared roles in Kanbans such as owner, editor, and viewer to control who can modify or delete notes and swimlanes.
- Different Kanbans for different process flows.
- Swimlanes for state management and not for notes, to keep notes simple and text-based.
- Option to view or download attachments by clicking on them.
- Owner option to ensure that unwanted users cannot delete or modify notes/swimlanes if the link is shared.
- Editor option to do the same as the owner, except delete the entire Kanban or change a user to owner.
- viewer option to move swimlanes and notes.
To run and use Canbemini, you will need the following:
A computer with a compatible operating system (such as Windows, macOS, or Linux). A compatible version of the Java Development Kit (JDK) installed on your computer. A compatible version of Gradle installed on your computer. A compatible version of Node.js installed on your computer.
You will also need a web browser installed on your computer to access the application through the browser. It is recommended to use an up-to-date version of a popular web browser such as Google Chrome, Mozilla Firefox, or Safari.
For building and running the application you need:
You will also need a web browser installed on your computer to access the application through the browser. It is recommended to use an up-to-date version of a popular web browser such as Google Chrome, Mozilla Firefox, or Safari.
Canbemini is a web application built using a combination of Spring Boot and Angular. It uses a H2 Data Base to store data and JPA for data persistence.
The application consists of a backend API built with Spring Boot and a frontend built with Angular. The backend handles all the logic for storing and retrieving data from the database, while the frontend is responsible for displaying the data to the user and handling user interactions.
The frontend communicates with the backend through a series of RESTful API endpoints. When a user performs an action, such as creating a new Kanban or moving a note, the frontend sends a request to the appropriate API endpoint on the backend. The backend then performs the necessary logic and returns a response to the frontend, which is used to update the user interface.
The application also uses Angular Material for its user interface components, such as buttons, forms, and tables. This helps to provide a consistent and visually appealing user experience.
In terms of security, the application uses JSON Web Tokens (JWTs) for authentication and authorization. When a user logs in, the backend generates a JWT and sends it back to the frontend, which is then stored in local storage. The frontend then sends this JWT with each subsequent request to the backend, which is used to verify the user's identity and authorize their actions. The JWT is stored in local storage instead of a cookie to prevent it from being accessed by third parties.
The application also has role-based access control, which allows the owner of a Kanban to invite collaborators and control their level of access. There are three roles: owner, editor, and collaborator. Owners have full control over the Kanban and can invite and remove collaborators, change their roles, and delete the Kanban itself. Editors have the same permissions as owners, except they cannot delete the Kanban or change the role of a user to owner. Collaborators can only move notes and swimlanes within the Kanban. This helps to ensure that only authorized users can make changes to the Kanban.
For building and running the application you need:
To run the Canbemini application, follow these steps:
- Clone this repository onto your computer.
- Make sure you are using JDK 17 and Gradle 7.6.
- Open a terminal.
- Install necessary dependencies: npm install
- Run the project: ng serve
- Open a web browser and go to http://localhost:4200 to see the application in action.
You can also run the Canbemini Spring Boot application as follows:
- Open a terminal in canbemini/api.
- Run the following command: gradle bootRun. More info about bootRun
- This will start the Spring Boot application and make it available at http://localhost:8080.
To use the Canbemini application, follow these steps:
- Open a web browser and go to http://localhost:4200.
- Click on the blue "Login" button located in the center of the screen.
- Enter one of the following emails and passwords to log in:
- cesar@email.com, password: 123
- mercedes@email.com, password: 123
- jacques@email.com, password: 123
- fredy@email.com, password: 123
- raul@email.com, password: 123
- Once you are logged in, you will see a list of your existing Kanbans. Click on one of them to open it.
- In the Kanban view, you can click and drag notes to move them between swimlanes and you can add new notes by clicking the "Add Note" button.
- You can also use the options in the top menu to add or delete swimlanes, change the Kanban's name, and invite collaborators.
- To attach a file to a note, click on the note and then click the "Add Attachment" button. You can either choose a file from your computer or enter a URL to attach it to the note.
- To view or download an attachment, click on it in the attachment list for the note.
The application has been tested with end-to-end tests using Cypress.
The following functionality has been tested:
-Login: error messages on the login form, displaying the password on the form, clicking the "remember me" button, logging out, and logging in with multiple users.
-Kanbans: the existence of a kanban, creating a new kanban, displaying error messages on the creation form, clicking on a kanban, entering and exiting a kanban to the main page, changing roles (one saving and one exiting), deleting a kanban (accepting and canceling), generating the sharing link, editing a kanban (accepting and canceling).
-Notes: verifying that at least one note exists in a specific swimlane, modifying a note, deleting a note (accepting and canceling), adding a note, clicking the attach button on a note.
-Swimlanes: adding a swimlane, verifying error messages, editing a swimlane (accepting and canceling), deleting a swimlane (accepting and canceling).
-Attachment: the following functionality has been tested and confirmed to work: uploading files (including .jpg, .pdf, and .txt), downloading, viewing (pdf only properly), and deleting attachments.
- Currently in development: Despite several attempts, testing for drag and drop functionality for both swimlanes and notes has not been successful. The .drag() and .triggers() functions have been attempted but have not produced the desired outcome.
To test the application with Cypress on your computer, you need to install Cypress, and then run the Cypress tests by executing the command 'npm test run' in your terminal. (Remember to run the command 'ng serve' to launch the UI and the command 'gradle bootRun' to launch the API before running the Cypress tests)
We welcome contributions to Canbemini! If you would like to report a bug or request a new feature, please open an issue on the GitHub repository.
If you would like to submit a bug fix or new feature, please follow these steps:
- Fork the repository and create a new branch for your changes.
- Make the necessary changes, including appropriate test cases.
- Update the documentation as needed.
- Submit a pull request for review.
- Please note that all contributions must follow our code of conduct and coding standards. We will review all pull requests and may request additional changes before merging.
We expect all contributors and users of Canbemini to treat each other with respect and kindness. Harassment of any kind will not be tolerated.
Please be considerate of others and their contributions to the project. Do not engage in any behavior that could be perceived as intimidating, threatening, or disrespectful.
We welcome contributions from people of all backgrounds and experiences. We encourage diversity and inclusivity and will make an effort to provide a safe and welcoming environment for everyone.
We follow the Angular Style Guide for Angular code, the Spring Boot Style Guide is currently in development . Please ensure that your code follows these guidelines before submitting a pull request.
Currently, it has been reported that the sharing option creates the share url, but the Kanban does not appear in the list of the person who logs in with that url.
It has been found that while viewing attachments, only .pdf files are displayed satisfactorily, while images and plain text files are not properly displayed.
Canbemini is licensed under the Apache License 2.0. This license allows users to use the project for commercial purposes, modify it, distribute it, and use it privately, as long as the copyright is acknowledged and a copy of the license is included with the project. However, it limits the user's liability and does not offer any warranties.
For more information, please see the Apache License 2.0.