Attendance Tracker 5000

The Attendance Tracker 5000 is an Attendance logging application that allows students to check in to their class on a given day. Teachers can view all of the students in a class and details about their individual attendance rates, as well as aggregated attendance data for the entire class.

The program has built with the SERN stack (MySQL, Express, React, Node.js) and is containerized for easy deployment. The system utilizes JSON Web Tokens to authenticate users and stores the tokens for a period of time to allow users to quickly return to the site.

Setup and running the program (current)

Current set up instructions:

The both the client and server are containerized by docker. If you do not have have docker installed, please follow the link below to install:

https://docs.docker.com/get-docker/
With docker installed, download the zip file, extract, and navigate using the CLI to the extracted file.
Run the following command in the CLI:

docker-compose up --build
This will begin both the client and server using local ports 3000 and 8080, respectively.
Navigate to http://localhost:3000 and log in with the desired username and password to explore the site.

Instructions for logging in

Currently the system utilizes mock data. To access the login information for any of our test users, please navigate to:

./server/data/users.json

There you can obtain the username and password for the currently added users.

### Setup and running the program (outdated)

To install the program:

Download the source files

Create a .env file for the server that is in the server's root directory

Inside the .env file, create variables for:

DB_URI

DB_NAME

DB_USERNAME

DB_PASSWORD

JWT_SECRET

Run the program by:

In the client directory, execute the command:

npm start

In the server directory, execute the command:

node server

By default the client is mapped to:

http://localhost:3000

and the server is mapped to:

http://localhost:8080

ndohertyjr/AttendanceTracker5000