⚠️ Important Notice: This project was finished as a school project and will be developed and published by Slynite from now on.

WorkTime Tracker

ℹ️ Note: This repository contains the source code and documentation of the practice project which we created in addition to our final exam. The project is not production ready and is still in development.

WorkTime Tracker is a web application that allows you to track your working hours. You can create projects and assign them to your tracked times.

For the reason that we want that a user can have a track about his/hers tracked times, we implemented a backend where the tracked times are stored and secured using user authentification.

🔨 Development Stuff

Tech Stack

⭐️ Next.js for the frontend and user backend
⭐️ TailwindCSS for styling
⭐️ Recoil for user state handling
⭐️ Appwrite as backend for user and userdata handling and storing

Local Development

To develop locally on this project you need to follow the next steps

Requipments

ℹ️ Note: On mac you can use Homebrew to install the requipments

Git

Node & NPM

Project

clone the repository using git
open code project in your IDE %DIR%/worktime-tracker-dev
rename next.config.js.example to next.config.js
change the variables in env and images block in the next.config.js file
run npm i in your terminal
run npm run dev to start the dev server

Appwrite Backend

To use this project, you need a running appwrite instance. Currently we are working on a tutorial/documentation how to setup the project, databases, etc.

💬 FAQ

Is this production ready?

In the current state this SaaS should only used locally. We are working hard to develop a stable release so that you can also run it as service outside you local network.

Can I help fixing issues or develop new features?

Yes of course! You can always help us improve this code to always provide new features and optimized builds. To start search for an existing issue/feature request or create one and ask if you can do this task. After finish developing, you can create a Pull-Request from you fork where we want to review your work.

❤️ Credits

Created with much ❤️, 🧠 and 😁 by

Worktime Tracker is a project mainly developed by Danny Schapeit and Jonas Bott as part of a school project. The project is licensed under MIT.

D3nn7 / worktime-tracker

readme