amandagibson / khronos

Khronos - CA final project. A time tracking application built using a REST API and ReactJS.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Khronos

As a trial you can log in with the following credentials:

user: susan_super

password: api_kitten


As our final two week project at CraftAcademy we created an application based on a RESTful API which allows users to track working time according to customer, project and task with the option to generate printable invoices for payment. The application is based on Kimai RESTful API (https://demo.kimai.org/api/doc).

You gain access to an account by e-mailing our support staff with a request. You log in by clicking 'Get Started Here' or via the log in button in the header.

Upon log in you are redirected to your dashboard which features Time Tracking, Statistics, and Invoicing.

In Time Tracking the user can record times in real time by clicking 'play' and 'stop' buttons or by selecting date and time via drop down calendar. Regardless of the method chosen, the user will be asked to fill in the other fields with information regarding rate-per-hour, customer, project and task before being able to save. The user also has access to previously recorded times here.

In the Statistics section there are bar graphs that show total working time and total money earned per month.

In Invoicing the user can filter timesheets by customer, project and/or task and toggle which times to bill for with the option of adding free text. A printable invoice is rendered.


Getting Started

Under the repository name, click clone or download. Copy the clone URL for the repository, open Terminal, change the current working directory to the location where you want the cloned directory to be made.

git clone https://github.com/CraftAcademy/khronos

Installing

Ensure that the dependency versions on your local machine are as specified in the package.json.

Run yarn install to install dependencies.

Run yarn start to open in localhost.


Testing

We use Cypress and Enzyme for testing. yarn run test runs unit tests. To run end-to-end Cypress tests run simultaneously yarn start and yarn cy:open by opening two terminal windows.


Deployment

We continuously deploy with netlify at https://khronostimetracking.netlify.com/


Built with


Authors


License

  • MIT License

Acknowledgments

Special thanks to our awesome coach Magnus!

About

Khronos - CA final project. A time tracking application built using a REST API and ReactJS.


Languages

Language:JavaScript 94.4%Language:CSS 4.8%Language:HTML 0.7%