Skip to content

Latest commit

 

History

History
194 lines (133 loc) · 6.59 KB

README.md

File metadata and controls

194 lines (133 loc) · 6.59 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Time Tracker

Time Tracker is a simple web interface based on Dash and Plotly, using NFC and a phone to do a simple time tracker.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

product-screenshot

The iPhone's automation opens up many interesting workflows, especially since it can scan NFC chips. They are cheap, small, and are very easy to program. Many people have their phone with them all the time, so it seems like a natural ally to your time tracking obsession.

It works in two steps: on your phone, you have one automation per task/NFC chip. It will update a file on dropbox, which will sync to your computer. Then, this software will allow you to see the results in a more beautiful and useful way.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Installation

  1. Clone the repo 
    git clone https://github.com/AdrienLF/Time_Tracker.git
  2. Install pip packages 
    pip install -r requirements.txt

Usage

The first thing you need to do is create the automations with your phone and NFC tags. The text must me as follows :

Current Date (all ISO 8601) - Longitude/Latitude - Name of your activity

Don't forget the spaces around the "-". You can add as many automations as you like, and name them as you like.

If you need more info on how to create shortcuts, please check the Shorcuts Tutorial.

You also don't need NFCs for all of them. It could trigger when you leave home, receive e-mails, etc.

Then, replace the path to your file in the Main.py file. I use dropbox, you can use any service that syncs your file from your phone to your computer.

product-screenshot

Then, run Main.py and open http://127.0.0.1:8050/ on your browser.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

Adrien Le Falher - @NEOkeitaro - adrienlefalher.pro [at] gmail.com

Project Link: https://github.com/AdrienLF/Time_Tracker