Skip to content

gvozdenkov/deep-focus

Repository files navigation


Deep focus logo

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
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

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 with npm

Installation

  1. Clone the repo
git clone git@github.com:gvozdenkov/deep-focus.git

#or

git clone https://github.com/gvozdenkov/deep-focus.git
  1. Install NPM packages
npm install
#or
yarn
  1. Start local service
  npm start
  #or
  yarn start

back to top

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 for a full list of proposed features (and known issues).

back to top

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
git switch dev
git pull
  1. Switch back to feature/AmazingFeature and rebase to dev: git rebase -i dev
  2. This will start interactive rebase and open text editor with something like this:
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'
  1. Change rebase actions for commits: first stay pick, then all s and the last one f -c, Then close text editor
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'
  1. After this new text editor will apper. Write your PR commit here. And close text editor.
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
  1. Force push your squashed commit to remote git push --force
  2. Inform that your PR is prepared for the merge in dev
  3. Take a coffee 🍺
  4. Your PR will be merged to dev in Rebase and merge mode

back to top

License

Distributed under the MIT License. See LICENSE.txt for more information.

back to top

Contact

Arty Gvozdenkov - telegram - gvozdenkov@gmail.com

back to top

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!

back to top

About

pomodoro time tracker

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors