Skip to content

NoteCatcher is a Web App for notes. 🗄Firebase 👨‍💻Python 🔗Microsoft Azure

License

Notifications You must be signed in to change notification settings

26ANSH/NoteCatcher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoteCatcher đź“ť

NoteCatcher, is a dynamic website for notes.

Add your notes and never forget anything, Delete them when your task is over.

It's a flask app connected to Firebase Real-Time Database.

Hosted on Azure App Service

Project directory layout

.
├── app.py                # Main App ~ Flask App
├── auth.py               # Database Communicator ~ Firebase Authentication  
├── template              # Html Pages ~ Jinja Templates
│   ├── index.html
│   ├── login.html
│   ├── signup.html
│   ├── 404.html
│   ├── template.html
│   └── success.html
│ 
├── static               # Images, CSS, JS
│   ├── style.css
│   ├── SVG/Images
│   └── script.js
│
├── requiremnts.txt      # Python Modules required for running the App
└── README.md

Live

NoteCatcher. Azure App Service

Hosted usign Azure's App Service

  • Flask App
  • Firebase Authentication
  • Firebase Real-Time Database

How to Run

After Cloning the Code Files on Your PC

Change current directory in the command prompt / Terminal

cd NoteCatcher

Now Follow These Steps !!!

  1. Installing Python Requirements

Install all modules by replacing <module>

pip3 install <module>

OR

Install all modules specified in requirements.txt

pip3 install -r requirements.txt
  1. adding your Configurations in auth.py
  • Go to Firebase Login Required
  • Create a Project
  • Create a Web App

drawing

  • Register your App and Copy Config Details to Your auth.py Paste it here in " "

drawing

drawing

  • enable Authenticate from Firebase Authentication

drawing

  • GoTo Firebase Realtime Database and add a Database for your app
  1. You are All Set up to Strt your App
python3 app.py

App Demo

  1. Landing Page

drawing

  1. Login/signup ~ Unique Email id linked to Firebase Auth

drawing

  1. Notes ~ Linked to Firebase Realtime Databse

drawing

  1. Adding and Deleting Notes With Notifications

drawing

drawing

  1. Logout ~ once looged in/logged out the app remembers it

drawing

  1. Error Handling

drawing

Future Plans

-> Upgrading this app to a custom UI without the Bootstrap ~ Vanilla CSS.

-> A Faster Backend with more features like Email Verfifivation, Calender Support, custom notifications, improved privacy, UI themes, Team notes and much more.

-> Transforming backend from Flask To maybe MERN or Django