Skip to content

Vlad29052003/Talio

Repository files navigation

Description of project

The application was developed in collaboration with five other students from TU Delft as part of the course Object-Oriented Programming Project.
Talio is a web application designed to help users manage projects and tasks. Talio allows users to organize tasks into different categories represented by boards. Within each board, tasks, represented as cards, can be assigned to different lists, allowing for a better organization. With Talio, users can easily create new boards, and track progress or set the level of priority using tags. Talio provides a powerful and intuitive way to organize your tasks and stay productive. Additionally, Talio offers support for collaborative work, allowing more users to view and edit a board at the same time. This way, we make it easier to track and manage group projects and help everyone be on track with his/her tasks.

Technology

The client is a single page web application developed using JavaFX. It uses http requests for comminication with the server. For synchronizing the changes made by other users, it uses web sockets and long polling.
The server is a REST API developed using Spring, one of the most popular Java frameworks for REST APIs. It is developed using the Model-View-Controller design.

How to run it

The application consists of two different parts: a REST API which serves as the server and manages the connection with the database and the client application which is built using JavaFX. In order to run the application,several steps are required to be performed.

Downloading the application

  1. Download the project repository and save it in the desired directory. The project can be found here.
  2. Open a terminal (for example cmd on Windows). This can be achieved by pressing Windows + R. In the menu that opens, type cmd and press Enter. This will open the Command Prompt.
  3. Type cd followed by the absolute path in the command prompt. For example, cd C:\Users\Username\Documents\oopp-group-48. Then press Enter.
  4. Run the following command gradlew build. This will build the project and install the needed dependencies. If the job succeeds, as it should, it will look something like this:

Running the server

  1. After completing the downloading phase and making sure that the project has been built, the server can be run.
  2. In the same terminal, type the following command: gradlew bootRun. This will wun the server. It should look like the following, if everything has been done correctly so far:

3. Now the server is running. It is running by default on `http://localhost:8080/`.

Running the client application

  1. Leave the terminal in which the server is running open.
  2. Follow the same procedure as before: open a new terminal and navigate to the project directory using the cd command.
  3. After reaching the directory, while having the server running (the application can be run without the server, but it will not have many features as most of them involve communication with the server) run the following command: gradlew run.
  4. Now, the client application has been opened, and the application can be used.

How to contribute to it

We are very pleased that you are interested in contributing to improving Talio. This document provides guidance and instructions on how you can get involved and make a meaningful impact on our project and improve the experience of the users.

Why Contribute

Our project is open-source. We believe that by collaborating with other developers, we can create a better product that is more useful and effective for our users. We welcome contributions from anyone who shares our vision and wants to make task organization and planning easier.

How to Contribute

There are many ways in which you can contribute to our project:

  1. Report bugs and issues: If you encounter any issues while using our application, please let us know. Please try to describe the bug as good as possible, so we can identify it easier.
  2. Suggest new features: If you have any ideas for new features that you think would be valuable, please open a new issue on our repository.
  3. Submit code: If you would like to contribute code to our project, fork our repository, create a new branch for your changes, and submit a merge request. It will be reviewed by our team.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published