https://github.com/nitinkedia7/smartwarningsystem
Real-time notifications for students in a lecture with mandatory acknowledgements, and reports to the teacher.
https://github.com/nitinkedia7/smartwarningsystem
android-app firebase firebase-cloud-functions
Last synced: 2 months ago
JSON representation
Real-time notifications for students in a lecture with mandatory acknowledgements, and reports to the teacher.
- Host: GitHub
- URL: https://github.com/nitinkedia7/smartwarningsystem
- Owner: nitinkedia7
- License: mit
- Created: 2018-05-13T09:07:29.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-13T11:37:01.000Z (about 7 years ago)
- Last Synced: 2025-02-06T14:32:53.969Z (4 months ago)
- Topics: android-app, firebase, firebase-cloud-functions
- Language: Java
- Homepage:
- Size: 5.43 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Smart Warning System
A real-time automatic warning system for (unattentive) students in an ongoing lecture, each notification requiring a touchscreen-tap acknowledgement in a timed window. Full class report or specifically the blacklisted students are available to the teacher on demand.
This application was developed as a course project for CS242/243 Software Engineering, IIT Guwahati. Detailed documentation namely SRS, Design, Code Review and Testing are available in the "documentation" sub-directory.
 
## Getting Started
### Prerequisites
```sh
Android Studio
Google Account
node with npm
```
### Development setup
#### [Initialise Firebase Project using your Google Account](https://firebase.google.com/docs/android/setup)
#### Local Android Studio Project
1. git clone https://github.com/nitinkedia7/SmartWarningSystem.git
2. Open the cloned folder in Android Studio
#### Firebase Cloud Function
1. [Getting Started for Cloud Functions](https://firebase.google.com/docs/functions/get-started)
2. Use this [file](https://github.com/nitinkedia7/SmartWarningSystem/blob/master/index.js) as index.js
3. Re-deploy
## App Usage Instructions
See [here](https://github.com/nitinkedia7/SmartWarningSystem/blob/master/documentation/AppUsageInstructions.pdf) for detailed usage instructions for the installed app both for the Student and Professor.
## Authors
* **[Nitin Kedia](https://in.linkedin.com/in/nitinkedia7)**
* **[Namit Kumar](https://in.linkedin.com/in/namitkrarya)**
* **[Jatin Goyal](https://in.linkedin.com/in/jatingoyal412)**
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request