https://github.com/mauricechouam/note-taker

An application that can be used to write, save, and delete notes. This application will use an express backend and save and retrieve note data from a JSON file.
https://github.com/mauricechouam/note-taker

express-backend express-js http postman routing

Last synced: about 2 months ago
JSON representation

An application that can be used to write, save, and delete notes. This application will use an express backend and save and retrieve note data from a JSON file.

• Host: GitHub
• URL: https://github.com/mauricechouam/note-taker
• Owner: mauricechouam
• Created: 2020-06-16T23:58:09.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T03:00:10.000Z (over 3 years ago)
• Last Synced: 2025-08-01T17:11:14.292Z (10 months ago)
• Topics: express-backend, express-js, http, postman, routing
• Language: JavaScript
• Homepage: https://notetaker-mauriceapp.herokuapp.com/
• Size: 44.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Note-Taker

[![GitHub license](https://img.shields.io/badge/licence-BSD3.0-green)](https://github.com/mauricechouam/Note-Taker)

An application that can be used to write, save, and delete notes. This application will use an express backend and save and retrieve note data from a JSON file.

## Table of Contents ##

  * [Description](#Description)

  * [User Story](#User_Story)

  * [Business Context](#Business_Context)

  * [Acceptance Criteria](#Acceptance_Criteria)

  * [Helpful links](#Helpful_links)

## Description

* The following HTML routes should be created:

  * GET `/notes` - Should return the `notes.html` file.

  * GET `*` - Should return the `index.html` file

* The application should have a `db.json` file on the backend that will be used to store and retrieve notes using the `fs` module.

* The following API routes should be created:

  * GET `/api/notes` - Should read the `db.json` file and return all saved notes as JSON.

  * POST `/api/notes` - Should receive a new note to save on the request body, add it to the `db.json` file, and then return the new note to the client.

  * DELETE `/api/notes/:id` - Should receive a query parameter containing the id of a note to delete. This means you'll need to find a way to give each note a unique `id` when it's saved. In order to delete a note, you'll need to read all notes from the `db.json` file, remove the note with the given `id` property, and then rewrite the notes to the `db.json` file.

## User Story

AS A user, I want to be able to write and save notes

I WANT to be able to delete notes I've written before

SO THAT I can organize my thoughts and keep track of tasks I need to complete

## Business Context

For users that need to keep track of a lot of information, it's easy to forget or be unable to recall something important. Being able to take persistent notes allows users to have written information available when needed.

## Acceptance Criteria

Application should allow users to create and save notes.

Application should allow users to view previously saved notes.

Application should allow users to delete previously saved notes.

## Helpful links

* [Express.js](https://expressjs.com/)

* [Postman](https://www.getpostman.com/)

- - -