This project is an extension of the base project FoodReady. This component of the Canteen Management System utilizes cloud functions to implement serverless triggers for real-time notifications to canteens and customers. It also facilitates seamless backend updates, ensuring that all stakeholders have the latest information without the need for constant polling or manual updates.
- Ensure you have Node.js installed on your local development machine.
- You should have access to Firebase or a similar platform that supports the deployment of cloud functions.
- Clone the project repository to your local machine.
- Navigate to the cloud functions directory within the project:
cd path/to/fr_functions-main - Install the required dependencies as defined in package.json by running:
npm install
- Login to Firebase using the Firebase CLI. If you're using a different provider, ensure you're logged in to their service:
firebase login - Once logged in and your project is set up on Firebase, deploy the cloud functions using the following command:
Adjust the command if you're using a cloud service other than Firebase, following their respective CLI documentation.
firebase deploy --only functions
- Notifications: The cloud functions automatically send notifications to both customers and canteens regarding order statuses, updates, and other important events, reducing the need for manual updates.
- Backend Updates: They handle the processing of data changes in the backend, ensuring that updates are reflected promptly across the platform.
We welcome contributions to improve the cloud functions or add new features. Please adhere to coding standards and submit your pull requests for review.
- Jay Joshi - Initial Prototype - Jay Joshi
This project is licensed under the MIT License - see the LICENSE.md file for details
- Inspiration: Long waiting queues at college canteens resulting in students being late to lectures after lunch breaks.