Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/faizan-akbar/hostel-management-system
Hostel Managment System
https://github.com/faizan-akbar/hostel-management-system
attendance-management-system mern mongodb react redux
Last synced: about 1 month ago
JSON representation
Hostel Managment System
- Host: GitHub
- URL: https://github.com/faizan-akbar/hostel-management-system
- Owner: faizan-akbar
- Created: 2024-05-28T15:50:54.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-29T20:02:52.000Z (7 months ago)
- Last Synced: 2024-09-20T09:04:51.109Z (3 months ago)
- Topics: attendance-management-system, mern, mongodb, react, redux
- Language: JavaScript
- Homepage:
- Size: 433 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# 🏢 Hostel Management Application
Developed with the MERN Stack and Redux, this application provides a comprehensive solution for managing hostel operations.
## 📦 Installation Instructions
1. Clone the repository:
```sh
git clone https://github.com/yourusername/hostel-management-app.git
```
2. Navigate to the project directory:
```sh
cd hostel-management-app
```
3. Install backend dependencies:
```sh
npm install
```
4. Navigate to the frontend directory and install frontend dependencies:
```sh
cd frontend && npm install
```
### 🛠️ Setup the .env File
Create a `.env` file in the root directory with the following content:
```env
NODE_ENV=development
PORT=5000
MONGO_URI=Your MongoDB URI
JWT_SECRET=Your JWT Secret Key
```
## 🚀 Features
- [x] User Registration and Login
- [x] Student Information Management
- [x] Add New Students
- [x] Edit or Remove Student Details
- [x] Update Student Locations
- [x] Daily Attendance Tracking
- [x] Attendance Records Display
- [x] Export Attendance Data as CSV
- [x] Delete Attendance Records from Previous Days
- [x] User List Management
- [x] Modify User Admin Privileges
- [x] Admin-Only Data Control
## 📂 Project Structure
The project structure includes:
- Backend: Contains the server-side code and APIs
- Frontend: Contains the client-side code and React components
- Redux: Used for state management
## 🌱 Environment Variables
### .env.example
Here's an example of what your `.env` file should look like:
```env
NODE_ENV=development
PORT=5000
MONGO_URI=Your MongoDB URI
JWT_SECRET=Your JWT Secret Key
```
## 📝 Usage
1. Start the backend server:
```sh
npm run server
```
2. Start the frontend development server:
```sh
cd frontend && npm start
```
3. Open [http://localhost:3000](http://localhost:3000) to view the application in your browser.
## 🤝 Contributing
Contributions are welcome! Please feel free to submit pull requests or open issues for any improvements or bug fixes.
## 📜 License
This project is licensed under the [MIT License](LICENSE).
---