Skip to content

About

An app for professionals to track the amount of time they spend on client projects.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Repository files navigation

clockwerks-time-tracker

An app for professionals to track the amount of time they spend on client projects.


Clockworks - Time Tracker

monokuma_honeypot

Application Version: 1.1

Developed by: Sauraav Jayrajh


Developer Contact Details:


Changelog:

1.1:

  • Users can now continue tracking an activity where they left off
  • Users can see their old activities in an expanded view for greater detail
  • Users can now edit the details of their old tracked sessions
  • Users can now see a visual representation of the amount of time they spent working in a custom timeframe
  • Users can now see a visual representation of the categories their sessions fall under and their consistency
  • Users can now sign in via Google Authentication instead of registering an account and logging in

1.0:

  • Release version, no changes yet.

Description:

Clockworks is a tool designed for freelancers and contractors. It allows individuals to record the details and amount of time they spend working on their professional activities.


Getting Started:

Software Requirements:

  • Android 8 Based Operating System
  • Internet Connection
  • Camera Permissions
  • Android Studio (If compiling the application yourself)

Hardware Requirements:

  • 1GB of RAM
  • 38MB of Free Storage

Installation Instructions:

For compiling yourself:

  1. Clone this repository to your local machine
  2. Open the solution in Android Studio
  3. Build the solution and run the application

For running the compiled version:

  1. Locate and install "app-debug.apk".

Usage:

Upon running the application, you will see a hamburger menu on the top left-hand side of your screen. It contains the options:

  • Sign In/Register (If Not Signed In) OR Log Out/Close (If Signed In): Allows users to log in or register if they do not have an account, or log out and close the application if they are already signed in.
  • Track Time: Manages and tracks time spent on tasks. Users can add new sessions, view existing sessions, and categorize their activities.
  • My Categories: Allows users to filter and view their tracked sessions by category.
  • My Goals: Lets users set and monitor their working time goals.
  • About: Provides some information about the application.

To select an option, simply click on it. Follow the on-screen instructions to complete the different tasks. Remember to refresh the app after adding your first task to see it reflected in the home feed.


FAQ:

General

Q: How do I sign up for the app?
A: To sign up, launch the app and tap the hamburger menu, then click on the "Sign Up" option. Enter your name, email, and desired password. The app will then register you successfully.

Q: How do I log into my account?
A: After signing up, you can log in by entering your email and password on the login screen. Alternatively, you can log in using your Google account by clicking on the "Log in with Google" button.

Q: What should I do if I forget my password?
A: Currently, if you have forgotten your password, you will need to register a new account or use the Google login feature.

Tracking Time

Q: How do I add a new session to track my activities?
A: Once logged in, click the plus button at the bottom of the home screen. This will open a window to track a new session. Enter a description, select a category, and optionally add photos. The start time is automatically populated based on the current time.

Q: How does the auto-calculation feature work?
A: The app can automatically calculate the end time and date for your session based on the start time and duration you worked. Leave the end fields blank to use this feature.

Q: How can I view my tracked sessions?
A: Your tracked sessions will appear on the home feed once you refresh the app after adding the first session. For all subsequent sessions, they will appear immediately.

Q: Can I edit an existing session?
A: Yes, click on any tracked session to bring up an interface where you can edit the description, category, and other details. Once done, press the back button to save your changes.

Categories

Q: Can I filter my sessions by category?
A: Yes, go to the "My Categories" screen from the hamburger menu. Here you can view all the tasks you've done grouped by category.

Goals

Q: How do I set goals for time worked?
A: Go to the goals section and set a minimum and maximum number of hours you want to work. The app will notify you once the goal is reached and will display your progress toward your daily goal.

Q: How can I track my progress toward my goals?
A: The progress towards your goals will be displayed in the goals section. The app will notify you once the goal is completed.

Images

Q: How can I add images to my sessions?
A: When you are adding a new session, you have the option to either upload an image from your device or take a new photo using the camera.

Analytics

Q: How does the pie chart and graph feature work?
A: The pie chart shows the total consistency of categories for your projects, and the graph indicates the time spent working. These graphs update in real-time as you add new sessions and activities.

Q: Why doesn't the task breakdown pie chart seem consistent with the number activities I have?
A: The pie chart considers the amount of time spent on each activity, not the number of activities. Therefore, the breakdown shows the proportion of time spent on different types of activities.


Plugins and Frameworks Used:

  • com.github.bumptech.glide:glide:4.14.1
  • com.google.firebase:firebase-auth:22.3.1
  • com.google.firebase:firebase-database:20.3.1
  • com.google.firebase:firebase-firestore:24.11.1
  • com.google.firebase:firebase-auth-ktx:22.1.0
  • com.google.android.gms:play-services-auth:21.2.0
  • com.google.android.material:material:1.11.0
  • com.github.PhilJay:MPAndroidChart:v3.1.0

Attributions/References:


Demos:

Demo of Working Application

Demo of Working Application - Updated


License:

This project is licensed under the MIT License.


About

An app for professionals to track the amount of time they spend on client projects.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages