Skip to content

Latest commit

Β 

History

History
115 lines (73 loc) Β· 3.33 KB

File metadata and controls

115 lines (73 loc) Β· 3.33 KB

πŸ“’ Note-App

GitHub stars GitHub forks GitHub issues GitHub license React Vite TailwindCSS JavaScript


Created by Sameer Khan – Aspiring React Engineer | JavaScript | NextJS | Open Source Contributor

A modern Note Taking App built with React and Vite, designed for managing personal notes efficiently.
This project demonstrates my skills in frontend development, component-based architecture, responsive design, and state management.


🌐 Live Demo

πŸ”— View the Live App


✨ Features

  • βž• Add Notes – Quickly create notes with a title and description.
  • πŸ“ Edit Notes – Update existing notes seamlessly.
  • ❌ Delete Notes – Remove notes you no longer need.
  • πŸ“± Responsive Design – Works perfectly on desktop, tablet, and mobile.
  • 🎨 Modern UI – Clean interface with React components.
  • πŸ’Ύ Local Storage – Notes persist even after page reload.

πŸ›  Tech Stack

  • Frontend: React, Vite, JavaScript, HTML, CSS, TailwindCSS
  • Build Tool: Vite
  • Version Control: Git & GitHub
  • Deployment: Vercel

πŸ“‚ Project Structure

NoteApp/ β”‚ β”œβ”€ src/ β”‚ β”œβ”€ Components/ # React components (Note.jsx, Notes.jsx) β”‚ β”œβ”€ assets/ # Images, icons, and SVGs β”‚ β”œβ”€ index.css # Global styles β”‚ └─ main.jsx # App entry point β”‚ β”œβ”€ public/ # Static files β”œβ”€ vite.config.js # Vite configuration β”œβ”€ package.json # Project metadata & dependencies └─ README.md # Project documentation



πŸš€ Installation & Setup

  1. Clone the repository:
git clone https://github.com/Samii2383/Note-App.git
cd NoteApp

2. Install dependencies:

npm install


3. Run the app locally:

npm run dev


4. Open in your browser:
πŸ‘‰ http://localhost:5173


🀝 Contributing

Want to contribute? Fork the repo and create a feature branch:

git checkout -b feature/your-feature
git commit -m "Add some feature"
git push origin feature/your-feature


Then open a Pull Request πŸš€

πŸ“œ License

This project is open-source and available under the MIT License.


---

πŸ‘¨β€πŸ’» My Contributions

Designed and implemented the UI components using React.

Integrated CRUD functionality (Create, Read, Update, Delete) for notes.

Added dark mode support and responsive design.

Managed state handling using React hooks.

Configured and deployed the project on Vercel for live demo access.

Documented the project with a professional README.