Skip to content

DineshBaghelDev/Ninja-Notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README: Ninja Notes App


Ninja Notes

A simple and user-friendly note-taking application built with React and Bootstrap. Ninja Notes helps you create, view, edit, and delete notes effortlessly.


Features

  • Add Notes: Create new notes with a title and description.
  • View Notes: See a list of all your saved notes.
  • Edit Notes: Update the title or description of existing notes.
  • Delete Notes: Remove notes you no longer need.
  • Dark/Light Theme Toggle: Switch between light and dark modes for a better user experience.

Getting Started

1. Prerequisites

  • Node.js and npm installed on your computer.
  • Basic knowledge of React and npm commands.

2. Installation

  1. Clone this repository:

    git clone https://github.com/your-username/ninja-notes.git
    cd ninja-notes
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev
  4. Open your browser and navigate to:

    http://localhost:5173
    

3. Usage Instructions

  1. Home Page:

    • View all your notes in a list format.
  2. Add a Note:

    • Click the "Add" button on the homepage.
    • Enter a title and description for your new note.
    • Click "Save" to add the note to your collection.
  3. Edit a Note:

    • Click the "Edit" button on the note you want to update.
    • Modify the title or description as needed.
    • Click "Save Changes" to update the note.
  4. Delete a Note:

    • Click the "Delete" button on the note you want to remove.
  5. Toggle Theme:

    • Use the theme toggle switch in the navigation bar to switch between light and dark modes.

Folder Structure

ninja-notes/
│
├── public/                # Static assets
├── src/                   # Source code
│   ├── Components/        # React components
│   │   ├── Navbar.js      # Navigation bar with theme toggle
│   │   ├── Home.js        # Home page to display notes
│   │   ├── CreateNote.js  # Form for adding new notes
│   │   ├── EditNote.js    # Form for editing existing notes
│   │   ├── Note.js        # Note card component
│   ├── App.js             # Main app component
│   ├── App.css            # Global styles
│   └── index.js           # Entry point
│
└── README.md              # Documentation

Technologies Used

  • React: For building the user interface.
  • React Bootstrap: For responsive and styled components.
  • React Router: For navigation between pages.
  • CSS: For custom styling.

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute it.


Credits

Images and icons used in this application are taken from flaticon.com. Content and images belong to their respective owners. The phrase in the footer "All Rights Reserved" is just for educational and fun purposes and does not imply any definite meaning.


Future Enhancements

  • Add search functionality to quickly find notes.
  • Implement tags or categories for better note organization.
  • Sync notes with a backend server for persistent storage.

Feel free to contribute or report issues to make Ninja Notes even better! 😊

About

A Simple Notes Taking React Application

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published