Dashboard
A community app built for IITH
Install / Use
/learn @LambdaIITH/DashboardREADME
<a id="readme-top"></a>
<br /> <!-- <div align="center"> --> <a href="https://dashboard.iith.dev">
IITH Dashboard
IITH Dashboard is an open-source platform designed to streamline campus activities, foster collaboration, and enhance the user experience for the IITH community. With features like Cabsharing, Mess Menu, Bus Schedule, and more, it aims to be a one-stop solution for campus management needs.
<div align="center"><img height="40" src="assets/images/app-store-badge.svg"> <img height="40" src="assets/images/play-store-badge.png">
</div> <p align="center"> <a href="https://dashboard.iith.dev">Access PWA</a> · <a href="https://github.com/LambdaIITH/dashboard/issues/new?labels=bug&template=bug-report---.md">Report Bug</a> · <a href="https://github.com/LambdaIITH/dashboard/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a> </p> <div style="display: flex; justify-content: space-around;"> <img src="assets/images/screenshots/1.png" alt="Screenshot 1" width="200px"> <img src="assets/images/screenshots/2.png" alt="Screenshot 2" width="200px"> <img src="assets/images/screenshots/3.png" alt="Screenshot 3" width="200px"> <img src="assets/images/screenshots/4.png" alt="Screenshot 4" width="200px"> <img src="assets/images/screenshots/5.png" alt="Screenshot 5" width="200px"> <img src="assets/images/screenshots/6.png" alt="Screenshot 6" width="200px"> </div>API Documentation
Getting Started
To get a local copy up and running, please follow the steps below
Prerequisites
Installation
Frontend
- Navigating to frontend directory from root of the repo
cd frontend - Install flutter dependencies
flutter pub get - If you are using your own device to run the app make sure its connected, after that run the app.
flutter run
Backend
- Navigate to the backend directory from the root
cd backend/backend - Install python dependencies with poetry
poetry install - Activate virtual environment
poetry shell - Run the FastAPI Server
uvicorn main:app --reload
Roadmap
- [x] Implement User Authentication
- [x] Add Cabsharing Feature
- [x] Integrate Mess Menu
- [x] Display Bus Schedule
- [x] Time Table/Calendar for academic and non-academic events
- [x] Lost and Found
- [x] Release on App Store
- [x] FCM for Notifications
- [ ] Marketplace (for buying used items)
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open-source community such a remarkable place to learn, inspire, and innovate. We welcome contributions to the IITH Dashboard, whether it be bug fixes, new features, improvements to the documentation, or any other enhancements. Anything which enhances the Dashboard are highly appreciated
Please read CONTRIBUTING.md for more detailed guide on contributing to this project.
License
Distributed under the MIT License. See LICENSE.md for more information.
Contact
- Lambda Support: support@iith.dev
Acknowledgments
Thank you to everyone who played a role in bringing the dashboard to life! We’re deeply grateful to the code contributors, those who suggested new features, reported bugs. Your collective efforts have been invaluable in bringing this project to life. <a href="https://github.com/LambdaIITH/dashboard/graphs/contributors"> <img src="https://contrib.rocks/image?repo=LambdaIITH/dashboard" /> </a>
