Skip to content

Markdown Notes App built with React Vite and Firebase Firestore. Effortlessly create, edit, and manage your notes in Markdown. ๐Ÿš€

License

Notifications You must be signed in to change notification settings

prerna-saraogi/markdown-notes-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

9 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Markdown Notes App

A Vite-powered, Firebase-backed, and user-friendly Markdown note-taking app. Effortlessly create, edit, and manage Markdown-based notes with real-time storage and retrieval powered by Firebase. This app ensures a fast, efficient, and seamless experience for organizing and structuring your thoughts in Markdown.

๐Ÿš€ Demo

View Live App

Features

  • Real-time Note Management - Create, read, update, and delete (CRUD) notes.

  • Rich Markdown Support โ€“ Write notes in Markdown format and preview them live.

  • Organized Notes โ€“ Recently modified or created notes appear at the top.

  • Firebase Integration โ€“ Secure, scalable, and real-time data storage & retrieval.

  • Auto-Saving โ€“ Notes are automatically saved as you type.

  • Dark & Light Mode โ€“ Toggle between themes for a personalized experience.

  • Minimal & User-Friendly UI โ€“ Clean, intuitive interface for seamless note management.

  • Vite-Powered Performance โ€“ Fast development and optimized production builds.

Tech Stack

Frontend - React (Vite), React MDE, Showdown, React Split, React Toggle Dark Mode, CSS.

Backend - Firebase Firestore (Cloud-based NoSQL database)

Installation & Setup

Before getting started, ensure Node.js and npm are installed on your system.

1๏ธ. Clone the Repository

  git clone https://github.com/prerna-saraogi/markdown-notes-app.git
  cd markdown-notes-app

2๏ธ. Install Dependencies

  npm install --legacy-peer-deps
  1. Configure Firebase:

    • Create a new Firebase project via the Firebase Console.

    • Enable Firestore Database

    • Obtain your Firebase configuration (API Key, Auth Domain, Project ID, etc.).

    • Create a .env file in the root directory and add your Firebase credentials (refer to .env.example).

  2. Start the Development Server

npm run dev

Contributing

Contributions are welcome! Feel free to fork the repo and submit a pull request.

License

MIT

About

Markdown Notes App built with React Vite and Firebase Firestore. Effortlessly create, edit, and manage your notes in Markdown. ๐Ÿš€

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published