CLOCK-ME

---

Author : BUKOSIA EBENEZAR

---

Project Description

Clock-me: is is a web application used to keep track of employees and thier clock-in and clock out time and also calculates their salary based on total clocked time.

---

Demo

SCREENSHOTS

Mobile View

Login

Password Recovery

Dashboard Panel

Admin Panel

Timecard Panel

Analytics Panel

Table of content

• Technologies
• Description
• Features
• Setup-process
• Project-usage
• Licence
• Copyright

---

Technologies

languages used are:

• Front-end

1. React(Typescript)
2. Sass

---

• Back-end

1. ruby(Active Record)

---

Features

• As a employee you can be able to:

1. Login with his/her account.
2. Reset his/her password
3. Record and track his/her timestamp.
4. view his/her weekly performances tatistics
5. View her salary

• AS an admin you can be able to:

4. Add new employees.
5. Update employees details.
6. Delete an Employee

---

description

This web application helps to solve the problem of tracing employees working time. This can be very essential espesialy jobs that pays thier employees on hourly basis. the application is also beneficial to a any company since it enables them track thier working times of thier employees and know how to optimize make thiem efficient. the application solve this such as recoding each day's clock-in and clock-out timestamp and record it in the database as string array. the application then uses the timestamps to calculate how many hours the employee has been working and compute the employees salary.

---

challenges

• Manipulating timestamps.
• Implementing theme change using sass.

---

How to set up and run the project

Requirements

• npm
• Text editor eg Visual Studio Code

---

Dependencies

• npm
• ruby

---

setup

Back end

clone the repo using the command

• git clone https://github.com/Ebenezr/clock-me-back-end.git

change directory using command

• cd clock-me-backend-end

open project in vscode texteditor

• code .

install dependancies gems

• bundle exec install

run server

• bundle exec rake server

---

Front end

clone the repo using the command

• git clone https://github.com/Ebenezr/clock-me-front-end.git

change directory using command

• cd clock-me-front-end

open project in vscode texteditor

• code .

install dependancies packages

• run npm install

run front end

• npm start

---

live link

• run the following live link in your browser
  https://clock-me-front-end.vercel.app

login Auths..

• admin:

username: admin password: admin

• employee:

username: elviskim password: elvis

How to use the project

---

Contributing to project

• Fork the repo

• Create a new branch in your terminal (git checkout -b improve-feature)
• Install the prerequisites
• Make appropriate changes in file(s)
• Run the server to see the changes
• Add the changes and commit them (git commit -am "Improve App")
• Push to the branch (git push origin improve-app)
• Create a Pull request

---

Copyright

Copyright(c)[2022][bukosia ebenezar]

---

Contact Information

• Email : [email protected]

---

License

MIT License Copyright (c) 2022 Bukosia Ebenezar