/notes-app

This is a simple web app built with React and Tailwind CSS that allows users to create, delete, and search notes.

Primary LanguageTypeScript

https://a-sticky-notes-app.vercel.app/

A Sticky Notes App

This is a simple web app built with React and Tailwind CSS that allows users to create, delete, and search notes. Below is a brief documentation of the app and how to use it.

Local Setup

  1. clone or fork the repo onto your computer
  2. download and install the latest version of node.js (https://nodejs.org/en/) for your Operating System
  3. using your Command Line navigate to the folder where the files are saved
  4. run 'npm i' to install all the dependencies
  5. next run 'npm run dev' to start the server on localhost:3000

How to Use

  • The main page displays all existing notes and a search bar to filter the notes.
  • To create a new note, click on the "New Note" button, enter a note text (between 20 and 300 characters), and click "Save".
  • To delete a note, click on the delete button located at the bottom of each note card.
  • To search for a note, type in a keyword or phrase in the search bar and press enter. The search will filter notes based on their content.

Features

  • Notes can be created, and deleted
  • Notes are saved in a Firebase database
  • Search functionality allows for easy retrieval of notes

Technologies Used

  • React.js
  • Tailwind CSS
  • Firebase

Future Improvements

  • Implement user authentication to enable secure access to notes
  • Add a character count validation to the note form for better user experience
  • Improve search functionality with more advanced filtering options
  • We hope you find this simple notes app useful! If you have any questions or feedback, please do not hesitate to reach out.