Welcome to the Worknote repository! 🙂
This project is dedicated to providing a seamless solution for synchronizing worklogs with a private corporate Jira server. The system aims to simplify the process of recording work time into journals, providing a centralized location for managing worklogs and assisting users with prompts for recurring events and tasks.
At workplaces, it is often required to track and document worklogs in journals or similar systems. Worknote offers a convenient way to enter worklogs and effortlessly synchronize them with your private corporate Jira server. The system provides a unified interface where users can easily manage their work time, view weekends and reduced working days, and receive prompts for recurring events and tasks that require time allocation.
- 🔁 Synchronization: Seamlessly synchronize worklogs with your private corporate Jira server.
- 🏛️ Centralized Management: All worklogs are stored and managed in a single location, providing easy access and organization.
- 🎉 Weekend and Reduced Working Day Display: Clearly visualize weekends and reduced working days to effectively plan and allocate work time.
- 🗓️ Production Calendar Integration: Automatic integration with the production calendar to mark work weeks with local holidays, reduced working days, and rescheduled work days (built-in integration with 🇷🇺 Russian calendar).
- ⏳ Remaining Time Tracking: Easily view how much time is left to write off for a specific day, ensuring accurate time allocation.
- 📆 Recurring Event and Task Prompts: Receive prompts for recurring events and tasks that require time allocation, ensuring no worklogs are missed.
- 📶 Workdays Counter: Keep track of the number of workdays you have already completed in your company or project, providing insights into your overall work progress.
- Multi-Language Support: The application offers support for three languages: 🏴 English, 🇪🇸 Spanish, and 🇷🇺 Russian.
- 🌚 Dark Theme: The app features a dark theme option that automatically synchronizes with the system-wide dark mode settings.
To install Worknote, follow these steps:
- Clone the repository:
git clone https://github.com/e1sordo/worknote - Navigate to the project directory:
cd worknote - Install dependencies:
mvn clean install
To use Worknote, follow these steps:
- Ensure you have completed the installation steps.
- Set required environment variables
export ENV_VAR_NAME=value - Launch the application:
sudo mvn --projects backend spring-boot:startin detached background mode and run even if you close the terminal. Can be stopped withsudo mvn --projects backend spring-boot:stop - Access the application through your preferred web browser at
http://localhost:8098. - Specify the details to connect to a private enterprise Jira instance using your credentials.
- Enter your worklogs, taking advantage of the system's features such as weekend and reduced working day display, remaining time tracking, and recurring event and task prompts.
- Click the sync button to synchronize your worklogs with Jira.
Before using Worknote, you must configure it by providing the necessary credentials and settings in the appropriate section of the application.
This application can be used in two scenarios:
- Deploy it on your local machine and have access to Worknote only from there.
- Or deploy it on a remote server and have access to Worknote from any device.
However, in the second scenario, you may encounter an issue with the corporate Jira server, which is located in the company's private network. In this case, you won't be able to make requests to Jira from outside your internal network.
To overcome this problem, you can use a special CORS proxy service located at the root of this repository. It runs as a regular OS-service on your machine with access to Jira and proxies any request from Worknote to Jira by bypassing the CORS protection.
Contributions are welcome! If you'd like to contribute to Worknote project, please follow these guidelines:
- Fork the repository.
- Create a new branch:
git checkout -b feature/my-feature - Make your changes and commit them:
git commit -m 'Add new feature' - Push the changes to your branch:
git push origin feature/my-feature - Submit a pull request detailing your changes.
Worknote is licensed under the MIT License. Feel free to use, modify, and distribute the software according to the terms of this license.
