Skip to content

A React and Vite-powered application for creating and managing markdown notes, utilizing Firebase for cloud database integration.

License

Notifications You must be signed in to change notification settings

architkakkar/MarkdownNotes-App

Repository files navigation

MarkdownNotes-App

MarkdownNotes-App is a modern, user-friendly application designed for creating and managing markdown notes. Built with React, Vite, and Firebase, this application leverages the power of React for building a dynamic and responsive UI, Vite for fast development and build times, and Firebase for seamless cloud database integration.

Project Link: https://architkakkar-markdownnotes-app.netlify.app/

Features

  • ReactJS: Utilizes ReactJS for building the user interface and managing the application state, showcasing its efficiency in handling user interactions and dynamic content.
  • Vite: Leverages Vite for fast development and optimized production builds.
  • Firebase: Employs Firebase for cloud database management, providing a scalable and reliable backend for storing and retrieving notes.

Getting Started

These instructions will guide you through setting up the project on your local machine for development and testing purposes.

Prerequisites

  • Node.js (v14.0.0 or later)
  • npm (v6.14.0 or later)

Installation

  1. Clone the repository: git clone https://github.com/architkakkar/MarkdownNotes-App.git
  2. Navigate to the project directory: cd MarkdownNotes-App
  3. Install the dependencies: npm install --legacy-peer-deps
  4. Start the development server: npm run dev

The app will be available at http://localhost:5173 in your web browser.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Archit Kakkar - @_architkakkar - business.architkakkar@gmail.com

Support

If you find this project useful, please consider giving it a star on GitHub. Your support is greatly appreciated!

Releases

No releases published

Packages

No packages published