https://github.com/wonjong2/note_taker

This Note Taker application allows a user to write, save and delete notes.
https://github.com/wonjong2/note_taker

api-rest expressjs javascript nodejs

Last synced: about 1 month ago
JSON representation

This Note Taker application allows a user to write, save and delete notes.

• Host: GitHub
• URL: https://github.com/wonjong2/note_taker
• Owner: wonjong2
• Created: 2022-05-01T18:41:19.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-05-06T00:20:41.000Z (about 4 years ago)
• Last Synced: 2025-10-28T15:36:07.554Z (8 months ago)
• Topics: api-rest, expressjs, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 138 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Note Taker

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

## Description

This is a Note Taker application that can be used to write, save and delete notes.

- Use node.js to implement this application

- Use express.js back end 

- Deploy an application to Heroku: https://note-taker-wonjong.herokuapp.com/

- Use nanoid.js to generate unique IDs

- Create a modular router for '/api/notes' path in notesRouter.js file

## Table of Contents

1. [Installation](#installation)

2. [Usage](#usage)

3. [License](#license)

4. [Contributing](#contributing)

5. [Test](#test)

6. [Questions](#questions)

## Installation

1. Move to the directory where index.js is

2. npm install express

3. node server.js

Please refer to the image below.

![install](./images/install.png)

## Usage

1. When a user open the Note Taker, it shows a landing page with a link to a notes page

![landing-page](./images/landing.png)

2. When a user clicks on the link to the notes page, it shows a page with existing notes listed in the left-hand column, plus empty fields to enter a new note title and the note's text in the right-hand column

![notes-page](./images/notes.png)

3. When a user enters a new note title and the note's text, a save icon appears in the navigation at the top of the page

![new-note](./images/new.png)

- When a user clicks on the save icon, the new note a user has entered is saved and appears in the left-hand column with the other existing notes

![add-note](./images/add.png)

4. When a user clicks on an existing note in the list in the left-hand column, that note appears in the right-hand column

![note-detail](./images/note-detail.png)

5. When a user clicks on the trash-can icon, that note will be deleted from the left-hand column

![delete-icon](./images/delete1.png)

![delete-note](./images/delete2.png)

## License

Copyright (c) 2022 `wonjong2` (GitHub Username) Licensed under [the MIT License](https://choosealicense.com/licenses/mit/).

## Contributing

All your inputs are valuable and I love them.

- Reporting a bug

- Submiiting a fix

- Proposing new features

## Test

N/A

## Questions

1. GitHub: https://github.com/wonjong2

2. If you have any questions, please reach out to wonjong2@gmail.com