Markdown Notepad

Welcome to the Markdown Notepad project! This is a simple React application that allows you to take notes with full Markdown functionality.

Table of Contents

• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Cloning the Repository
  • Running the Application
• Contributing
• License

Features

• Create, edit, and delete notes
• Supports Markdown syntax
• Real-time preview of Markdown notes
• Responsive design for desktop and mobile devices

Technologies Used

• React
• React Markdown
• CSS
• Local Storage

Getting Started

Prerequisites

Make sure you have the following installed on your machine:

• Node.js (version 14 or later)
• npm (comes with Node.js)

Cloning the Repository

To get a local copy of the repository, follow these steps:

1. Open your terminal or command prompt.
2. Navigate to the directory where you want to clone the repository.
3. Run the following command:

   git clone https://github.com/jaitensahu/Notepad.git

Installation

After cloning the repository, navigate into the project directory:

cd Notepad

Next, install the necessary dependencies by running:

npm install

Running the Application

To start the application, use the following command:

npm start

This will launch the app in your default web browser at http://localhost:3000.

Usage

Once the application is running, you can start creating notes by:

• Typing your content into the input area.
• Using Markdown syntax for formatting (e.g., # Heading, *italic*, **bold**, etc.).
• Viewing the rendered Markdown in real-time in the preview area.
• Saving your notes, which will be stored in your browser's local storage for later access.

Contributing

We welcome contributions to improve this project! Here’s how you can contribute:

1. Fork the project.
2. Create your feature branch:

   git checkout -b feature/YourFeature

3. Commit your changes:

   git commit -m 'Add some feature'

4. Push to the branch:

   git push origin feature/YourFeature

5. Open a Pull Request.