Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2003harsh/coding-club-jnu
A web app for managing attendance. Trainers set timings, students mark attendance online, and new students receive WhatsApp invites. Built with HTML, CSS, JavaScript, Node.js, and MongoDB, featuring CI/CD and Docker support.
https://github.com/2003harsh/coding-club-jnu
Last synced: about 2 months ago
JSON representation
A web app for managing attendance. Trainers set timings, students mark attendance online, and new students receive WhatsApp invites. Built with HTML, CSS, JavaScript, Node.js, and MongoDB, featuring CI/CD and Docker support.
- Host: GitHub
- URL: https://github.com/2003harsh/coding-club-jnu
- Owner: 2003HARSH
- License: mit
- Created: 2024-10-11T10:04:47.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T14:11:24.000Z (3 months ago)
- Last Synced: 2024-10-20T12:53:50.336Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.55 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JNU Coding Club Attendance System
## Overview
The JNU Coding Club Attendance System is a web application designed to streamline the attendance marking process for trainers and students. This project enables trainers to set attendance timings, allows students to mark their attendance online, and ensures that attendance records are easily accessible to both parties. Additionally, new students will automatically receive a WhatsApp group invitation upon marking their first attendance.
## Features
- **Attendance Timing Management**: Trainers can set specific timings for attendance.
- **Online Attendance Marking**: Students can mark their attendance from anywhere.
- **Attendance Records Access**: Both trainers and students can view attendance records.
- **Automatic WhatsApp Invitations**: New students receive a WhatsApp group invitation after marking their first attendance.
- **Online Database Storage**: Attendance data is securely stored in a MongoDB database.
- **Tech Stack**:
- **Frontend**: HTML, CSS, JavaScript
- **Backend**: Node.js
- **Database**: MongoDB
- **Version Control**: GitHub
- **Deployment**: Netlify, AWS
- **Continuous Integration/Continuous Deployment (CI/CD)**: A CI/CD pipeline is implemented to ensure seamless integration and deployment.
- **Containerization**: The application is containerized using Docker.
## Installation
To set up the project locally, follow these steps:
1. Clone the repository:
```bash
https://github.com/2003HARSH/Coding-Club-JNU.git
cd Coding-Club-JNU
```
2. Set up the backend:
- Navigate to the backend directory.
- Install the required dependencies:
```bash
npm install
```
- Configure your environment variables for database connection.
3. Set up the frontend:
- Navigate to the frontend directory.
- Install the required dependencies:
```bash
npm install
```
4. Run the application:
- Start the backend server:
```bash
node server.js
```
- Start the frontend application:
```bash
npm start
```
5. Access the application:
Open your web browser and go to `http://localhost:3000`.
## Usage
- **For Trainers**:
- Log in to the admin panel to set attendance timings and view records.
- **For Students**:
- Register and log in to mark your attendance and view your records.
## CI/CD and Deployment
This project uses GitHub Actions for CI/CD, ensuring that any changes pushed to the main branch are automatically tested, containerized and deployed to production environment.
## Docker
To run the application in a container, use the following commands:
1. Pull the Docker image from dockerhub:
```bash
docker pull 2003harsh/attendance-system-frontend:latest
```
2. Run the container:
```bash
docker run -p 3000:3000 2003harsh/attendance-system-frontend:latest
```
## Contributing
We welcome contributions! If you would like to contribute to the project, please follow these steps:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/YourFeature
```
3. Make your changes and commit them:
```bash
git commit -m 'Add your feature'
```
4. Push to the branch:
```bash
git push origin feature/YourFeature
```
5. Open a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgements
- Special thanks to the JNU Coding Club for the inspiration and support.
- Thanks to all contributors for their efforts in making this project a success.
## Contact
For questions or feedback, please reach out to [[email protected]](mailto:[email protected]) OR [[email protected]](mailto:[email protected])