Skip to content

Latest commit

Β 

History

History
118 lines (86 loc) Β· 3.05 KB

README.md

File metadata and controls

118 lines (86 loc) Β· 3.05 KB

πŸ“ Notes App

A simple and clean note-taking web application built with Node.js, Express, and EJS. This app allows you to create, view, search, and delete notes β€” all in an elegant interface.


βš™οΈ Tech Stack

  • Node.js – Server runtime
  • Express.js – Web framework
  • EJS – HTML templating
  • Vanilla CSS – Page styling
  • Nodemon – Auto-restarts server in dev mode

πŸš€ Features

  • βœ… Create new notes with title & content
  • πŸ” Search notes by title
  • πŸ“ƒ View full content of each note
  • πŸ—‘ Delete notes
  • 🎨 Clean responsive UI
  • πŸ”§ In-memory storage (no database)

πŸ“ Folder Structure

notes-app-exp/
β”œβ”€β”€ public/
β”‚   β”œβ”€β”€ notes.css              # Styles for notes list view
β”‚   β”œβ”€β”€ singleNote.css         # Styles for single note view
β”‚   └── style.css              # Shared/general styles
β”‚
β”œβ”€β”€ views/
β”‚   β”œβ”€β”€ createNote.ejs         # Form to create a note
β”‚   β”œβ”€β”€ errMessage.ejs         # Error display page
β”‚   β”œβ”€β”€ index.ejs              # Optional: redirects or root view
β”‚   β”œβ”€β”€ notes.ejs              # List & search all notes
β”‚   └── singleNote.ejs         # Display individual note
β”‚
β”œβ”€β”€ db.mjs                     # In-memory data store
β”œβ”€β”€ index.mjs                  # Main Express app and routes
β”œβ”€β”€ package.json               # Project metadata & scripts
β”œβ”€β”€ package-lock.json          # Dependency lock file
└── README.md                  # You're reading it now!

πŸ› οΈ Setup Instructions

  1. Clone the repository
git clone https://github.com/yourusername/notes-app-exp.git
cd notes-app-exp
  1. Install dependencies
npm install
  1. Run the development server
npm start
  1. Visit in browser
http://localhost:3000/notes

πŸ“Œ App Routes

Method Route Description
GET /notes View all notes (and search)
GET /notes/:id View a single note
GET /createNote Show form to create a note
POST /createNote Save the new note
POST /notes/:id/delete Delete a specific note

πŸ”’ Note on Storage

This app uses an in-memory array in db.mjs to store notes temporarily.
Restarting the server will clear all notes.

For persistence, consider integrating a database like MongoDB, SQLite, or PostgreSQL.


🌱 Future Improvements

  • Add persistent database support
  • Add edit/update functionality
  • Add user authentication
  • Improve mobile responsiveness
  • Support Markdown in notes

πŸ‘¨β€πŸ’» Author

Your Name
GitHub: @hitesh-ctrl


πŸ“„ License

This project is licensed under the MIT License.