Skip to content

ajaysainath/markdown-notes-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 

Repository files navigation

📝 Markdown Notes App

A full-stack Markdown Notes Application that allows users to create, edit, preview, and manage notes with real-time Markdown rendering and auto-save functionality.


🚀 Features

  • 🧾 Create, update, and delete notes (CRUD)
  • ⚡ Real-time Markdown preview (split-screen)
  • 💾 Auto-save with debounce (no manual save needed)
  • 🔍 Search notes by title and content
  • 📂 Sidebar layout for easy navigation
  • 🗄️ Persistent storage using SQLite
  • 🎨 Clean and modern UI

🛠️ Tech Stack

Frontend

  • React.js
  • Axios
  • React-Markdown

Backend

  • Node.js
  • Express.js

Database

  • SQLite

📸 How It Works

  • Left side shows all saved notes

  • Right side provides:

    • Markdown editor
    • Live preview
  • Notes auto-save after typing stops

  • Click a note to edit it

  • Delete notes instantly


⚙️ Setup Instructions

1. Clone the Repository

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

2. Run Backend

cd backend
npm install
node server.js

Backend runs on: http://localhost:5000


3. Run Frontend

cd frontend
npm install
npm start

Frontend runs on: http://localhost:3000


🔗 API Endpoints

Method Endpoint Description
GET /notes Get all notes
POST /notes Create note
PUT /notes/:id Update note
DELETE /notes/:id Delete note

🧠 Key Engineering Decisions

  • Implemented debounced auto-save to prevent excessive API calls
  • Used React state management for real-time UI updates
  • Designed RESTful APIs for clean backend communication
  • Structured project with clear separation of frontend and backend

🌱 Future Improvements

  • User authentication (JWT)
  • Version history for notes
  • Tags and categories
  • Dark mode
  • Deployment (Vercel + Render)

📌 Author

Ajay Sainath


⭐ Conclusion

This project demonstrates full-stack development skills, including frontend UI design, backend API development, database integration, and performance optimization using debounce techniques.

About

Full-stack Markdown Notes App with autosave, search, and real-time preview

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors