https://github.com/nanda-gopal-sb/attendance-tracker
A complete open-source solution for tracking attendance in colleges
https://github.com/nanda-gopal-sb/attendance-tracker
Last synced: 4 months ago
JSON representation
A complete open-source solution for tracking attendance in colleges
- Host: GitHub
- URL: https://github.com/nanda-gopal-sb/attendance-tracker
- Owner: nanda-gopal-sb
- Created: 2025-01-06T18:51:01.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-19T08:03:22.000Z (4 months ago)
- Last Synced: 2025-02-19T08:24:50.803Z (4 months ago)
- Language: HTML
- Homepage:
- Size: 739 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Roadmap: roadMap.txt
Awesome Lists containing this project
README
# College Attendance Management Tool
This project is an open-source tool for managing a college's attendance. It can handle most types of requirements, such as a variety of classes.
## Official Repository
This is the official repository for my DBMS mini-project for college.
## Technology Stack
- Frontend: Static vanilla HTML and CSS with occasional Tailwind
- Backend: Node.js with the Express framework
## Running the Application
## Prerequisites
Before running the application, ensure you have the following installed:
- [Node.js](https://nodejs.org/)
- [PostgreSQL](https://www.postgresql.org/)
## Backend Directory Structure
The backend directory contains the following structure:
```
├── backend
│ ├── apiEndPoints
│ │ ├── admin_api.js
│ │ ├── student_api.js
│ │ └── teacher_api.js
│ ├── auth
│ │ └── auth.js
│ ├── db-helpers
│ │ ├── const-local.js
│ │ └── main.js
│ ├── htmlHandlers
│ │ └── admin.js
│ ├── index.js
│ ├── package.json
│ ├── package-lock.json
│ └── utils
│ └── email.js
```
A file named `const-local.js` is expected to be in the `db-helpers` directory.
```js
const host = '';
const port = 8080; //add your port
const password = '';
const database = '';
const user = '';
const ssl = false; //usually set true for cloud based
const emailKey = ""; // this can be generated from the app-passwords section
```
You must also excute the /database/ddl.sql file in your terminal/gui application.
1. Navigate to the backend directory:
```sh
cd backend/
```
2. Install the necessary dependencies:
```sh
npm install
```
3. Start the application:
```sh
node index.js
```
4. Login with the sample admin user set up,
```txt
password : admin
username : admin
```