Skip to content

Commit

Permalink
Updated Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ByteNinjaSmit committed Nov 30, 2024
1 parent fa4166e commit 5749abd
Show file tree
Hide file tree
Showing 14 changed files with 35 additions and 11 deletions.
46 changes: 35 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Hostellers Sahayyak

![Hostellers Sahayyak Logo](https://via.placeholder.com/150)
![Hostellers Sahayyak Home](./client-js/public/screenshot/Homepage.png)

**Hostellers Sahayyak** is an innovative project designed to improve the hostel experience for students by addressing two key challenges: efficient grievance resolution and seamless attendance management. With advanced features like biometric attendance and a robust grievance system, this platform bridges the gap between students and hostel management, ensuring a better living environment for hostellers.

Expand Down Expand Up @@ -57,11 +57,11 @@
```
├── client
├── components
| ├──layout
| ├──layout
├── pages
| ├── client
| ├── admin
| ├── dev
| ├── client
| ├── admin
| ├── dev
├── styles
├── server
Expand All @@ -86,7 +86,7 @@

1. Clone the repository:
```bash
git clone https://github.com/your-username/hostellers-sahayyak.git
git clone https://github.com/ByteNinjaSmit/Hostellers-Sahayyak-Express.git
```

2. Navigate to the project directory:
Expand Down Expand Up @@ -157,11 +157,35 @@

## 📊 Screenshots

### Login
![Login Page](/client-js/public/screenshot/Login.png)

### User Dashboard
![User Dashboard](/client-js/public/screenshot/User%20Dashboard.png)

### Grivience Form
![Grivience Form ](/client-js/public/screenshot/Grivience%20Form.png)

### Admin Dashboard
![Admin Dashboard](/client-js/public/screenshot/Admin%20Dashboard.png)

### Grievance Dashboard
![Grievance Dashboard](https://via.placeholder.com/800x400)
![Grievance Dashboard](/client-js/public/screenshot/Grivience%20Management.png)

### Grievance Action
![Grievance Action](/client-js/public/screenshot/Grivince%20Action.png)

### User Management Dashboard
![User Management Dashboard ](/client-js/public/screenshot/User%20Management.png)

### Attendance Dashboard
![Attendance Dashboard ](/client-js/public/screenshot/Attendance%20Dashboard.png)

### Attendance List
![Attendance List ](/client-js/public/screenshot/Attendance.png)

### Biometric Attendance
![Biometric Attendance](https://via.placeholder.com/800x400)
![Biometric Attendance](/client-js/public/screenshot/Biometric.png)

---

Expand Down Expand Up @@ -194,16 +218,16 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
## 🙌 Acknowledgments

- Special thanks to our mentors and peers for their guidance.
- Tools and frameworks that made this project possible: [Next.js](https://nextjs.org/), [MongoDB](https://www.mongodb.com/), [TailwindCSS](https://tailwindcss.com/).
- Tools and frameworks that made this project possible: [Next.js](https://nextjs.org/), [React.js](https://react.dev/),[React + Vite](https://vitejs.dev/), [Express.js](https://expressjs.com/), [MongoDB](https://www.mongodb.com/), [TailwindCSS](https://tailwindcss.com/).

---

## 📬 Contact

For any queries, feel free to contact:
- **Smitraj Bankar**
- Email: [smitrajbankar11@gmail.com](mailto:your-email@example.com)
- GitHub: [@ByteNinjaSmit](https://github.com/your-username)
- Email: [smitrajbankar11@gmail.com](mailto:smitrajbankar11@gmail.com)
- GitHub: [@ByteNinjaSmit](https://github.com/ByteNinjaSmit)

---

Expand Down
Binary file added client-js/public/screenshot/Admin Dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/Attendance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/Biometric.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/Grivience Form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/Grivince Action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/Homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/Login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/User Dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client-js/public/screenshot/User Management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5749abd

Please sign in to comment.