jayantasamaddar / green-note

Green Note - React Note App

Green Note is a simple and lightweight note-taking web application built using React.js. It provides essential features such as creating, searching, deleting, and saving notes to local storage. Additionally, you can mark notes as completed and even add image snippets to your notes.

Table of Contents

• Features
• Installation
• Usage
• Local Storage
• Contributing
• License

Features

1. Create and Delete Notes: You can easily create new notes and delete them when you no longer need them.

2. Search Notes: Find your notes quickly with the built-in search feature. Just start typing, and Green Note will filter your notes in real-time.

3. Mark Notes as Completed: Keep track of completed tasks by marking notes as done. It's a great way to stay organized and focused.

4. Local Storage: Green Note utilizes local storage to save your notes, so you won't lose your data even if you close your browser.

Installation

To get started with Green Note, follow these steps:

1. Clone the repository from GitHub:

   git clone https://github.com/your-username/green-note.git
   cd green-note

2. Install the required dependencies using npm or yarn:

   npm install
   # or
   yarn install

3. Start the application:

   npm start
   # or
   yarn start

This will start the development server and open the app in your default web browser. You can access the app at http://localhost:3000/.

Usage

Once the app is running, you can perform the following actions:

• Create a Note: Click the "New Note" button to create a new note. You can give it a title and add your content.

• Delete a Note: Hover over a note and click the trash can icon to delete it.

• Search Notes: Use the search bar at the top to search for specific notes.

• Mark Notes as Completed: Click the checkbox icon on a note to mark it as completed.

• Add Image Snippets: To add an image snippet, paste the image URL in the note content, and it will be displayed.

Local Storage

Green Note saves your notes in the browser's local storage. This means that your notes are preserved even if you close the browser or refresh the page. However, please note that this data is stored locally on your device, and it won't sync across different devices or browsers.

Contributing

We welcome contributions from the open-source community to make Green Note even better. If you'd like to contribute, please follow these steps:

1. Fork the repository on GitHub.
2. Create a new branch with a descriptive name for your feature or bug fix.
3. Make your changes and ensure they follow the project's coding standards.
4. Test your changes thoroughly.
5. Create a pull request (PR) with a clear description of your changes.
6. Your PR will be reviewed, and once approved, it will be merged into the main branch.

License

This project is licensed under the MIT License - see the LICENSE file for details.

If the license file is not found, you can add a button like this:

Thank you for using Green Note! We hope it helps you stay organized and productive.

GitHub Repository