Skip to content

nayan-agrawal/markdown-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

Markdown Editor Application

This is a simple Markdown Editor application built with React and Node.js. It allows users to create and edit Markdown text and see the rendered output in real-time.

Features

  • Create and edit Markdown text
  • Real-time preview of rendered Markdown

Installation

To run this application locally, follow these steps:

Prerequisites

  • Node.js installed on your machine

Steps

  1. Clone the repository:

    git clone https://github.com/nayan-agrawal/markdown-editor.git
  2. Navigate to the project directory:

  3. Install dependencies for the Node.js server:

    cd backend
    npm install
  4. Start the Node.js server:

    npm start
  5. Open a new terminal window/tab and navigate to the client directory:

    cd ../web-app
  6. Install dependencies for the React client:

    npm install
  7. Start the React development server:

    npm start
  8. The application should now be running locally. You can access it in your web browser at http://localhost:3000.

Usage

  • Enter Markdown text in the editor on the left-hand side.
  • The rendered Markdown will appear in real-time on the right-hand side.
  • Edit the Markdown and see the changes instantly in the preview.

Technologies Used

  • React
  • Node.js
  • Express

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/new-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add new feature')
  5. Push to the branch (git push origin feature/new-feature)
  6. Create a pull request

License

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

Feel free to modify this README file according to your project's structure, additional features, or any other specific details about your Markdown editor application.