Author: Kyle Beasley
Email: kyle@lacoxconsulting.com
An api-based employee time clock system. This project utilizes ExpressJS and MariaDB running on a Raspberry Pi for the back-end and supports multiple front-ends running on other computers' localhosts. In this example, XAMPP is used by the client computers.
In theory, this project could be extended to function using a live domain, however, a constraint on this project was the lack of internet access.
In this instance, communications are handled by a cheap wireless router.
The front end features a "Help" page which helps an end user to use the setup and run the entire time clock system.
I want to note this is not intended to be used by others. You can, I just don't recommend it. I won't help you make it work. I will not be accepting any suggested edits either. This is a project showcase for future employers and for my personal record-keeping.
Thank you for checking this out!
TNT Security Solutions was contracted to provide security for a large outdoor music festival and was looking for a way to manage their users and keep a time clock. The festival is being held in a rural location meaning cell service and broadband internet service are hard to come by. Ideally, the solution shouldn't rely on an external internet connection.
After some deliberation, it was decided a simple ID number and barcode system would provide the level of reporting and management TNT required.
TNT intends to continue using this system for all future field jobs.
- All front-end code (sans the .gif used on the help pages, and the logo in the header.)
- All back-end code
- User List and Time Clock management tools utilizing python
- Wireless Router
- For this example, this router was used.
- Raspberry Pi
- Other computers will work. They just need to be able to run Node.js
- Experience using ExpressJS would be beneficial
- Secondary "client" computers. These will all be equipped with barcode scanners.
Download and extract the full .zip file from GitHub.
You can use a router without an internet connection. All you have to do is turn it on, and it'll broadcast a local network that devices can use to communicate. Login to the router, set up your network's name and password, then connect your client devices to the routers new network.
The login information can usually be found on the back or bottom of the device.
Transfer the /backEnd directory to the computer which will act as the server. There are multiple ways to do this however, this isn't a tutorial for that. FWIW, when transferring files to my Pi, I found FileZilla to be the easiest by far.
Inside the /backEnd directory on the server, install all required packages with the command npm install, then run npm start
This installs all required packages from the package.json file, as well as fires up Node.js / Express at the server's Local IP address, PORT 5000
NOTE: This port can be adjusted in the server.js file located in the /backEnd directory. Be sure to make the corresponding changes to the index.js and register.js files located in the /frontEnd directory.
In my case, the database lived on the Raspberry Pi along with the server. If you'd like to follow the same structure I used, the database is named stationTimeClock. It contains two tables, userlist and timeclock.
To create userlist:
CREATE TABLE userlist (
'id' INT AUTO_INCREMENT KEY,
'number' VARCHAR(10) NOT NULL,
'name' VARCHAR(100) NOT NULL,
);To create timeclock:
CREATE TABLE timeclock (
'id' INT AUTO_INCREMENT KEY,
'number' VARCHAR(10) NOT NULL,
'action' VARCHAR(10) NOT NULL,
'date' VARCHAR(100) NOT NULL,
'time' VARCHAR(100) NOT NULL,
);I would recommend leaving all of this the same as it comes. Otherwise, you'll need to update all references to the database in every single query the API makes.
Again, I used XAMPP to serve the website locally on each "client" computer. If you aren't familiar with where to place the /frontEnd directory, here's a tutorial.
You could probably get away with using the Live Server extension for VSCode.
The website can be found at http://localhost/{front_end_folder_name}
confirmUsers.py - Takes a CSV of workers, creates an ID for each of them, creates a unique link for each user, assigns the user to a group based upon shift time, and inputs all that created information into a new CSV. The resulting CSV file is intended to be used for a mail merge, where instructions for the user's shifts can be emailed to the user with each user's unique ID times, and links to download their ID. The server must be running for this.
guardsToDB.py - Takes the list of guards created by confirmUsers.py and adds each user to the database. The server must be on and running for this.
outputTimeClock.py - Does what it says. Outputs all shifts for each user to a CSV file. The server must be on for this.
dbdupe.py - Checks the database for duplicate names and numbers. Mostly a sanity check as the user creation process contains self checks to avoid duplicating a user.
codeToPDF.py - Creates a PDF ID card for each user in the userlist. Then takes every one of those PDFs and combines them into a single PDF meant to be printed before the event.
If you're wanting to use these scripts, be ready for some errors. They're written for our specific needs and may not function with your spreadsheets without some minor modifications.
Aside from Barcode.js, and the Node Modules, all code featured in this project is written by myself.
This project was a great learning experience. I've gained an understanding of what an API is used for, and what it is doing "behind the scenes." With this understanding, my skill set as a front-end developer has expanded to include a critical component of the industry, and I am more confident in my ability as a programmer.
I also wanted to make sure I took the time to document and explain the project to anyone who may come across it. It also allows me more experience writing clear documentation and using the Markdown language.
I want to give a shout-out to Robert Evans, host of the podcast Behind the Bastards (the 19th most popular podcast on Apple Podcasts as of the time of writing this), for putting out the 6-part banger, "G. Gordon Liddy, the Fascist Behind Watergate". Your tongue-in-cheek humor got me through the process of learning asynchronous functions. Also, while I respect your opinions of baseball, I do not agree with them.