Skip to content

borngreat-ikwutah/Notes_Application

Repository files navigation

Notes Application

This simple, feature-rich Notes Application was built using React, React Router, TypeScript, uuidv4, and Bootstrap. It allows users to create, edit, and delete notes seamlessly.

Features

  • Create, Edit, and Delete Notes: Easily manage notes with a clean, intuitive interface.
  • Unique Note IDs: Each note is assigned a unique ID using uuidv4.
  • TypeScript Support: Ensures type safety and improved developer experience.
  • Responsive UI: Styled with Bootstrap for a consistent look across devices.

Technologies Used

  • React: A JavaScript library for building user interfaces.
  • React Router: Used for routing to navigate between pages.
  • TypeScript: Adds type-checking to improve code reliability and maintainability.
  • uuidv4: Generates unique IDs for each note.
  • Bootstrap: Provides responsive and reusable CSS components.

Installation and Setup

  1. Clone the repository:
    git clone https://github.com/your-username/notes-app.git
  2. Navigate into the directory:
    cd notes-app
  3. Install dependencies:
    npm install
  4. Run the application:
    npm start

Project Structure

  • /src/components: Contains all reusable components like the note editor, list view, and form.
  • /src/routes: Contains the main routes managed by React Router.
  • /src/utils: Utility functions, including UUID generation and helpers.

Usage

  • Creating a Note: Use the "New Note" button to add a new note.
  • Editing a Note: Select a note from the list to view or edit its contents.
  • Deleting a Note: Each note has a delete option for easy removal.

Future Improvements

  • Tagging System: Add tags to organize notes.
  • Search Functionality: Quickly find notes with a search bar.
  • Dark Mode: Enable a dark theme for better readability at night.

Feel free to customize any part to suit your project’s specifics!

About

Notes Application is done with React, React-Bootstrap, Typescript for error-checking and lastly, with many uuidv4 for different ids, also ReactRouter

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors