https://github.com/gvozdenkov/deep-focus
pomodoro time tracker
https://github.com/gvozdenkov/deep-focus
Last synced: 23 days ago
JSON representation
pomodoro time tracker
- Host: GitHub
- URL: https://github.com/gvozdenkov/deep-focus
- Owner: gvozdenkov
- License: gpl-3.0
- Created: 2023-07-27T05:18:59.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T09:15:54.000Z (over 1 year ago)
- Last Synced: 2025-01-05T12:42:32.420Z (over 1 year ago)
- Language: JavaScript
- Size: 141 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
The most simple tool for tracking time and earnings for freelancers.
Nothing extra. Only the time spent, cost and compact reports.
---
## Required functionality
1. Creation of clients and projects.
2. Accounting for the hourly rate globally and for each client. By default, the global rate applies
to all customers.
3. Adding comments about the work done for each project. Comments are added throughout the day as
sessions complete. All comments will be added as a list to the daily statistics for each project.
4. You can manually delete and add project work records.
Minimum required set of reports:
1. Result for the day. What projects did you work on, how many sessions / time spent and the value
earned.
2. Result for a month (or any time interval) with similar metrics.
3. Quick calculation of the final cost of the work done. The report includes the total time spent
and cost. As well as a tablet with sessional or daily records of the time spent and comments on the
work done.
Table of Contents
## Built With
I plan to work with MERN stack
_Frontend_: React, Redux, TanStack
_Backend_: exressJS, mongoDB
## Local development
This is an example of how you may give instructions on setting up your project locally. To get a
local copy up and running follow these simple example steps.
### Prerequisites
You need install [node.js](https://nodejs.org/en/download/current) with npm
### Installation
1. Clone the repo
```sh
git clone git@github.com:gvozdenkov/deep-focus.git
#or
git clone https://github.com/gvozdenkov/deep-focus.git
```
2. Install NPM packages
```sh
npm install
#or
yarn
```
3. Start local service
```sh
npm start
#or
yarn start
```
## Roadmap
- [ ] Create Technical Task
- [ ] Mockup UI
- [ ] Create basic UI components with storybookJS
- [ ] Mocup server for dev
- [ ] Basic business logic
- [ ] Create real server
- [ ] Add user account / registration
- [ ] Advanced business logic
See the [open issues](https://github.com/gvozdenkov/deep-focus/issues) for a full list of proposed
features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and
create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull
request. You can also simply open an issue with the tag "enhancement". Don't forget to give the
project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch `git switch -c feature/AmazingFeature`
3. Stage your changes `git add .`
4. Commit your Changes `git commit -m 'Add some AmazingFeature'`
5. Push to the Branch `git push origin feature/AmazingFeature`
6. Open a Pull Request
7. After confirming the pull request update `dev` branch
```sh
git switch dev
git pull
```
8. Switch back to `feature/AmazingFeature` and rebase to `dev`: `git rebase -i dev`
9. This will start interactive rebase and open text editor with something like this:
```sh
pick c0c67ad 'commit message in feature/AmazingFeature'
pick 62f32d3 'commit message in feature/AmazingFeature'
pick s6566df 'commit message in feature/AmazingFeature'
pick qw455er 'commit message in feature/AmazingFeature'
pick 345rett 'commit message in feature/AmazingFeature'
```
3. Change rebase actions for commits: first stay `pick`, then all `s` and the last one `f -c`, Then
close text editor
```sh
pick c0c67ad 'commit message in feature/AmazingFeature'
s 62f32d3 'commit message in feature/AmazingFeature'
s s6566df 'commit message in feature/AmazingFeature'
s qw455er 'commit message in feature/AmazingFeature'
f -c 345rett 'commit message in feature/AmazingFeature'
```
4. After this new text editor will apper. Write your PR commit here. And close text editor.
```sh
feat/refact/fix/style: resulting text of your PR commit
#separate the body of the commit with a new empty line from the title (if you need the body)
Changelog of this commit:
1. Bla-bla-bla
2. And bla
3. And bla-bla
```
5. Force push your squashed commit to remote `git push --force`
6. Inform that your PR is prepared for the merge in `dev`
7. Take a coffee :beer:
8. Your PR will be merged to `dev` in `Rebase and merge` mode
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Arty Gvozdenkov - [telegram](https://t.me/gvozdenkov) - gvozdenkov@gmail.com
## Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a
few of my favorites to kick things off!
- [Choose an Open Source License](https://choosealicense.com)
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
- [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
- [Malven's Grid Cheatsheet](https://grid.malven.co/)
- [Img Shields](https://shields.io)
- [GitHub Pages](https://pages.github.com)
- [Font Awesome](https://fontawesome.com)
- [React Icons](https://react-icons.github.io/react-icons/search)
[contributors-shield]:
https://img.shields.io/github/contributors/gvozdenkov/deep-focus.svg?style=for-the-badge
[contributors-url]: https://github.com/gvozdenkov/deep-focus/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gvozdenkov/deep-focus.svg?style=for-the-badge
[forks-url]: https://github.com/gvozdenkov/deep-focus/network/members
[stars-shield]: https://img.shields.io/github/stars/gvozdenkov/deep-focus.svg?style=for-the-badge
[stars-url]: https://github.com/gvozdenkov/deep-focus/stargazers
[issues-shield]: https://img.shields.io/github/issues/gvozdenkov/deep-focus.svg?style=for-the-badge
[issues-url]: https://github.com/gvozdenkov/deep-focus/issues
[license-shield]:
https://img.shields.io/github/license/gvozdenkov/deep-focus.svg?style=for-the-badge
[license-url]: https://github.com/gvozdenkov/deep-focus/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png
[Next.js]:
https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]:
https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]:
https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]:
https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]:
https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]:
https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]:
https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]:
https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com