Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.23 KB

README.md

File metadata and controls

75 lines (54 loc) · 2.23 KB

NoteAble | Note Keeping Application

Overview

This Note Keeping Application is a simple yet functional web-based tool designed to manage notes efficiently. Users can create, read, update, and delete notes, as well as search for specific notes based on keywords. The application is built using React.js for the frontend with Chakra UI for user interface.

This project was developed as part of the training program at Foothill Technology Solutions.

Features

  • Search Functionality: Find notes easily using the search field.
  • Note Creation: Add new notes with content and a creation date.
  • Note Update: Modify the content of existing notes.
  • Note Deletion: Remove notes with a confirmation dialog.
  • User-friendly Interface: Built with Chakra UI for a modern and responsive design.

Technologies Used

  • React.js: A JavaScript library for building user interfaces.
  • Chakra UI: A simple, modular, and accessible component library for React.

Setup and Installation

Prerequisites

  • Node.js
  • npm or yarn

Installation

  1. Clone the repository: 
    git clone https://github.com/Jamal-SaadEddin/NoteAble-FE.git
  2. Navigate to the project directory: 
    cd NoteAble-FE
  3. Install the dependencies: 
    npm install
    or 
    yarn install

Running the Application

  1. Start the development server: 
    npm start
    or 
    yarn start
  2. Open your browser and navigate to http://localhost:3000.

Backend Integration

This frontend application complements the backend component. For more information on the backend, refer to the My Note Keeper Backend Repository.

Authors

Acknowledgements

  • This task is part of the Foothill Technology Solutions Internship Cycle.
  • Big thanks to my trainer @Huthaifa
foothill logo

Thank you for visiting my project! Feel free to star or contribute to the repository if you find it useful.