johnnyboysydney / note_taker

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.

Note_Taker

Table of Content

• Description
• User-Story
• Working-app
• Installation
• Dependencies
• Built-With
• Questions
• Contributors
• Author
• Images
• Demo
• Acknowledgements
• Copyright

Description

Creating 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 following HTML routes was created: GET /notes - Returns the notes.html file. GET * - Returns the index.html file
The application has db.json file on the backend that will be used to store and retrieve notes using the fs module
The following API routes were created:
GET /api/notes - It reads the db.json file and return all saved notes as JSON
POST /api/notes - It receives a new note to save on the request body, adds it to the db.json file, and then return the new note to the client
DELETE /api/notes/:id - It receives a query parameter containing the id of a note to delete
In order to delete a note, the app reads all notes from the db.json file, removes the note with the given id property, and then rewrites 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

Working app

https://hidden-lake-44335.herokuapp.com/notes

Installation

There is no installation required

Dependencies

• FS
• Express
• Path

Built With

• VScode - The editor of choice
• Notepad++ - My second editor
• Gitbash - What would we do without our bash?
• Heroku - Perfect to upload dev work for testing out

Questions

1. How can I run the application?
   You just need to click on the link from your favorite browser

2. What if I get an error?
   Ensure that your browser is working properly

3. Is this for writing notes on my broswer?
   Yes, that is correct. At least its light weight and you can access it from anywhere in the world.

Contributors

I am the sole contributor for this project.

Licence

This project is licensed under the MIT- License

Author

John Merchan

Images

Demo

Acknowledgements

My thanks to Aditya and Vishal and special thanks to Agustinn; An amazing team of professional developers, who thrive teaching and sharing their knowledge

CopyRight

Copyright 2020 © John Merchan