Skip to content

Latest commit

 

History

History
69 lines (54 loc) · 3.69 KB

README.md

File metadata and controls

69 lines (54 loc) · 3.69 KB

my-note-keeper-react 📓📓

FTS-TASK9 - facilitating CRUD (Create, Read, Update, Delete) operations using Node.js and ReactJS

🌠 Overview

This repository creates a note-keeping application that performs CRUD operations on notes. It consists of a frontend (FE) component that complements the backend (BE) part of the website.

Note -> the backend of this project was made earlier it can be found here -> https://github.com/dohmeid/my-note-keeper

🎯 Features

  • Each note has: a title, content, a creation date.
  • The frontend part of the app facilitates the CRUD (Create, Read, Update, Delete) operations implemented in Node.js.
  • The app implements the following endpoints:
    • GET /notes: Retrieve all notes.
    • POST /notes: Add a new note.
    • DELETE /notes/:id: Delete a specific note using its ID.
    • PUT /notes/:id: Update a specific note using its ID.
  • The app conects to a MongoDB database and uses Mongoose for object modeling.
  • The app handles the potential errors gracefully. If an error occurs, the API returns a suitable status code and a descriptive error message.

👾 Technologies Used

🕹️ Getting Started

To run this application locally, follow these steps:

  1. prepare the server side app by following these steps

    • Clone the backend repository -> git clone https://github.com/dohmeid/my-note-keeper.git
    • Go to folder my-note-keeper-react -> cd my-note-keeper
    • Install the required dependencies -> npm i express mongoose npm i --save-dev dotnet nodemon
    • Make sure you have MongoDB installed and running locally.
    • Start the server using: npm start

  2. prepare the client side app by following these steps

    • Clone the backend repository -> git clone https://github.com/dohmeid/my-note-keeper-react.git
    • Go to folder my-note-keeper-react -> cd my-note-keeper-react
    • Install the required dependencies -> npm i
    • Start the development server using -> npm start
    • You can access the project by navigating to http://localhost:3000 in your web browser.

👁️ Preview

  1. get all the notes get

  2. add a new note add

  3. delete a note delete

  4. update a note update

  5. search for a note search