Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abhisinha08/build-a-thon-project

NotiSmart - A Smart and configurable multi-threaded notification engine built with Python-Flask, MySQL, HTML, TailwindCSS and JavaScript. Project by Team 404 Found for Build-a-Thon Hackathon organized by IITG
https://github.com/abhisinha08/build-a-thon-project

flask hackathon hackathon-project html javascript mysql python tailwindcss

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/abhisinha08/build-a-thon-project
Owner: AbhiSinha08
Created: 2021-10-02T19:43:29.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-10-25T16:36:14.000Z (about 3 years ago)
Last Synced: 2024-11-09T22:41:34.305Z (about 2 months ago)
Topics: flask, hackathon, hackathon-project, html, javascript, mysql, python, tailwindcss
Language: Python
Homepage:
Size: 39.6 MB
Stars: 2
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# NotiSmart - _A Smart and Configurable multi-threaded trigger notification engine_
### Project by Team 404: Found for Build-a-Thon Hackathon organized by IITG
#### Made using Python-Flask, MySQL, HTML, TailwindCSS and JavaScript

### Presentations: [PDF](https://drive.google.com/file/d/1UzXM07sIJ5gz0jCkOs47qC-H1YZNR7c8/view) , [Video](https://drive.google.com/file/d/1RCuF44Y-WDSxCskHYgIEwwubK8SOY2rR/view?usp=sharing)

### Team Members
- [Karuna Sharma](https://github.com/Karunasharma09)
- [Abhinav Sinha](https://github.com/AbhiSinha08)

# Usage Guide
This Project requires the following tools:
- Python 3.6 or higher
- MySQL 80
- A Web Browser (yeah, sorry😐)

## Getting Started
### Step 0: Clone the repository and cd into the project directory
```
$ git clone https://github.com/AbhiSinha08/Build-a-Thon-Project.git
$ cd Build-a-Thon-Project
```
### Step 1: Install the dependencies listed in `requirements.txt`
```
$ pip install -r requirements.txt
```
### Step 2: Make Sure that you have a MySQL Server up and running either in your local computer or hosted remotely
If not, You can download [MySQL community](https://dev.mysql.com/downloads/) Server for your operating system from [here](https://dev.mysql.com/downloads/mysql/)
Installation instructions for the same can be found [here](https://dev.mysql.com/doc/refman/8.0/en/installing.html)
### Step 3. Configure the app to work perfectly as per your needs
- Open the `config.ini` file with any text editor to edit your MySQL user and password in the respective fields for the notification engine to connect to it.

*(You can also edit host and port number if the MySQL Server is hosted remotely)*
###### _The configuration file `config.ini` is pretty structured and simple to edit all your configurations in one place and not to edit everything in the code everytime._
- From here, you can also change other configurations for the app to use like -- the email account to send email notifications from, password for the admin portal, MySQL Database name for the app to use and much more...
###### The default password for the admin portal is 'admin'
- Optionally, You can also customize some notification content to send to employees for some specific triggers which don't need the entire notification text to be entered everytime. This can be done from editing the `notifications.ini` file inside the `static\` folder of the project.
### Step 4: Run
Run the Notification Engine Server by running either `flask run` **OR** `python app.py` command

By default, a flask application runs on port `5000` on `localhost`. So head over to http://localhost:5000 and start using!
### Step 4.1: :star:Star [this repository](https://github.com/AbhiSinha08/Build-a-Thon-Project) if you like our work⭐