The Attendance Logging App is a simple Node.js and Express.js application for logging and managing attendance records. It allows you to add attendance records, search for records by name, and store them in a PostgreSQL database. This README provides an overview of the project, how to set it up, and how to use it.
- Create new attendance records with student details.
- Search for attendance records by name.
- Store records in a PostgreSQL database.
- Sort and filter records by name or time.
- Handle errors and edge cases gracefully.
-
Clone the Repository:
git clone https://github.com/yourusername/Attendance.git cd attendance-logging-app -
Install Dependencies: npm install
-
Set Up the PostgreSQL Database: Create a PostgreSQL database and update the database connection settings in
db.js. -
Run the Application: npm start
-
API Endpoints:
POST /attendance: Add an attendance record.GET /attendance: Get all attendance records.GET /attendance/search?name=John: Search attendance records by name.GET /attendance?sortBy=name: Sort records by name.GET /attendance?sortBy=time: Sort records by time.GET /attendance?filterByCourse=Math101: Filter records by class.
6.Adding Records: To add a new attendance record, make a POST request to /attendance with the following JSON data:
{ "name": "John Doe", "course": "Math101", "matric_number": "12345678" }
7.Searching Records: To search for attendance records by name, make a GET request to /attendance?name=John.
8.Sorting Records: To sort records by name, make a GET request to /attendance?sortBy=name. To sort records by time, make a GET request to /attendance?sortBy=time.
9.Filtering Records:
To filter records by class, make a GET request to /attendance?filterByClass=Math101.
The application handles various errors and provides appropriate error messages for missing input, database errors, and record not found situations.
This project is licensed under the MIT License - see the LICENSE file for details.