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.
- Create and edit Markdown text
- Real-time preview of rendered Markdown
To run this application locally, follow these steps:
- Node.js installed on your machine
-
Clone the repository:
git clone https://github.com/nayan-agrawal/markdown-editor.git
-
Navigate to the project directory:
-
Install dependencies for the Node.js server:
cd backend npm install
-
Start the Node.js server:
npm start
-
Open a new terminal window/tab and navigate to the client directory:
cd ../web-app
-
Install dependencies for the React client:
npm install
-
Start the React development server:
npm start
-
The application should now be running locally. You can access it in your web browser at http://localhost:3000.
- 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.
- React
- Node.js
- Express
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository
- Create a new branch (git checkout -b feature/new-feature)
- Make your changes
- Commit your changes (git commit -m 'Add new feature')
- Push to the branch (git push origin feature/new-feature)
- Create a pull request
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.