NotiFlow is a comprehensive notification management system designed to streamline and enhance communication flows. This guide covers the steps necessary to set up and run NotiFlow on your local machine.
Before you start, make sure you have the following installed:
- Visual Studio Code
- Node.js and npm
- WAMP or XAMPP server
- Firebase account
Follow these steps to set up your environment:
Clone the repository from GitHub or download from Google Drive:
- GitHub: NotiFlow Repository
- Google Drive: Download ZIP
If downloaded as a ZIP file, unzip the folder and open it using Visual Studio Code.
Open two terminals in Visual Studio Code:
- In the first terminal, run
cd frontendto navigate to the frontend directory. - In the second terminal, run
cd backendto navigate to the backend directory.
Run npm i in both the frontend and backend terminals to install the required Node.js packages.
- Open a new terminal and navigate to the message backend with
cd message_backend. - Install dependencies with
npm i.
- Start your WAMP/XAMPP server and access phpMyAdmin.
- Create a new database named
notiflow. - Import the provided database file by selecting the import tab and clicking the "Go" button.
Set up a Firebase project to manage authentication and other services required by NotiFlow.
Run npm start in both the frontend and backend terminals to start the servers.
Access the system through your local setup or via the hosted version at http://notiflow.site.
When registering, please include the country code with the contact number.
To access the admin panel:
- URL:
/admin/login - Username:
admin - Password:
admin
Contributions to NotiFlow are welcome. Please feel free to fork the repository, make changes, and submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
Thanks to everyone who has contributed to the development of NotiFlow!