PlaceMe By CEAL

High Priority Placement Notifications

· Documentation · Report Bug · Request Feature

Don't forget to ⭐ the repo

📔 Table of Contents

• About the Project
• Roadmap
• Contributing
• FAQ

🌟 About the Project

📷 Screenshots

Server

• Node.js
• Firebase

🎯 Features

• Send high priority push notifications
• Saving all the placement calls for future reference
• Ability to edit and add new placement calls

🧰 Getting Started

‼️ Prerequisites

• Install flutter and Node.js in your system
• Create an account in firebase and turn on authentication with google,firestorage, and firestore database

🏃 Run Locally

Clone the project

https://github.com/ATS527/ceal-placement-notifer

Install all the dependencies

flutter pub get

Create a .env file in project root directory

SERVER_URL="your-custom-server-url"
API_KEY="your-custom-api-key"

SERVER_URL is the url of server in which firebase-admin sdk is present, API_KEY is to avoid unauthorised api calls

🚩 Deployment

To get the optimised build run

flutter build appbundle

🧭 Roadmap

• Create user profile
• User preferences for notifications

👋 Contributing

Contributions are always welcome!

❔ FAQ

• Does the application works out of the box?
• No, you need to setup firebase first, then configure node.js server with firebase-admin sdk and run a notification server to really test the application.