Skip to content

Swaniket/notes-bucket

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes Bucket

Notes bucket is a feature-rich notes application, where users can create, edit, view, and delete notes.

Features

  • Full authentication system (login and signup).
  • Emoji and Markdown support for notes.
  • Organization of notes by tags.
  • Ability to pin and archive notes.
  • Search Notes & Filter notes by tags
  • Encryption of notes in the DB.
  • User Profile page for some quick KPI and ability to update user profile.

Screens

  1. Login

  1. Signup

  1. Home Page

  1. Home Page - Filter by Tag

  1. Home Page - Search

  1. Create New Note

  1. Create Note - Immersive Mode

  1. Edit Note

  1. View Note

  1. Delete a note

  1. Quick Settings menu

  1. Manage Tags Page

  1. Manage Tags Page - Search

  1. Manage Tags Page - Add a tag

  1. Manage Tags Page - Remove a tag

  1. Profile Page

Tech Stack

  • ReactJS + Vite
  • Redux-Toolkit
  • Axios
  • Bootstrap
  • Node + ExpressJS
  • MySQL

How to run on the local machine

It would be best if you had the following installed in your system to run the project

  1. NodeJS
  2. MySQL

After installing these -

  1. Go to the dbScripts folder and run the createTables.sql file to create the tables locally.
  2. Go to the api folder and run npm install.
  3. After the installation is done, run npm run dev to run the express server locally.
  4. Go to the ui folder and run npm install.
  5. After the installation is done, run npm run dev to run the vite server locally.

Roadmap

  • Add notes encryption in the database.
  • Add the forgot password module.
  • Edit Password module.
  • First Login Instructions - Add a tag to get started.
  • Build a more modern UI.