https://github.com/codingerik/notetaker

A lightweight application to keep and save notes in.
https://github.com/codingerik/notetaker

Last synced: 6 months ago
JSON representation

A lightweight application to keep and save notes in.

• Host: GitHub
• URL: https://github.com/codingerik/notetaker
• Owner: CodingErik
• License: mit
• Created: 2020-07-06T09:37:16.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T05:47:29.000Z (over 3 years ago)
• Last Synced: 2023-03-08T15:14:45.793Z (about 3 years ago)
• Language: JavaScript
• Homepage: https://notestakerr.herokuapp.com/
• Size: 269 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Note Taker

![GitHub Language Count](https://img.shields.io/github/languages/count/codingErik/noteTaker?label=Languages%20Used&logo=GitHub)

![GitHub Followers](https://img.shields.io/github/followers/codingErik?color=orange&label=Followers&logo=GitHub)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2FCodingErik%2FteamGenerator)

## Description

Create 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.

* The application frontend has already been created, it's your job to build the backend and connect the two.

* 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.

## Deployed link 

You can see the live heroku app here [note taker](https://notestakerr.herokuapp.com/)

## Installation

to run the application run ```git clone``` run  ```npm i ```then run the script ```npm run start ```

## Contribution 

If you would like to contribute to the repo please submit a pull request.