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

Application to to write and save notes which uses an Express.js back end and will save and retrieve note data from a JSON file.
https://github.com/aniraannu/note-taker

Last synced: about 1 month ago
JSON representation

Application to to write and save notes which uses an Express.js back end and will save and retrieve note data from a JSON file.

• Host: GitHub
• URL: https://github.com/aniraannu/note-taker
• Owner: aniraannu
• Created: 2024-06-25T20:59:31.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-16T17:00:12.000Z (5 months ago)
• Last Synced: 2024-08-16T18:31:00.105Z (5 months ago)
• Language: JavaScript
• Size: 1.55 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Note Taker

A simple application that can be used to write and save notes. This application will use an Express.js back end and will save and retrieve note data from a JSON file.

## Description

The application can be simply described as a Note Taker that allows any user to creates notes which are saved in db.json file using the 'fs' module. The notes that are save can also be retrieved and displayed in the UI for the  user. The started code was given with the front-end code. 

The following animation demonstrates the application functionality: 

![A user can add a note with title and text field, save it and also clear the form if needed. the saved notes will appear on the left hand side.](./public/assets/images/11-express-homework-demo.gif)

## Getting Started

The completed application looks like:

![Image of the completed Application.](./public/assets/images/note-maker-homepage.png)

The notes page opens up when the user presses get started button on the homepage. The Notes page has two sections: Existing notes are listed on the left side and a section to add new notes on the right side. The notes page looks like the following image:

![Image of the Notes Page.](./public/assets/images/note-maker-notespage.png)

Once the user enters the Note title and note text, Save Note button and clear form button appears on the right hand side of the page as shown in the image below. The notes get saved once the user hits save button and appears along with the rest of the notes in the right section

![Image showing Save notes button and ckear form button](./public/assets/images/note-maker-newnotes.png)

The existing notes can also be deleted using the delete button along with the notes.

### Dependencies

* express 4.16.4

* uuid 8.3.2

* uuidv4 6.2.13

### Installing

* Application is deployed using render

### Executing program

* The application code can be cloned from the following Github link:

[GitHub-note-taker](https://github.com/aniraannu/note-taker)

## Help

NA

## Authors

Contributors names and contact info

Anira Raveendran

[@aniraannu](https://github.com/aniraannu)

## Version History

* 0.1

    * Initial Release

## License

None

## Acknowledgments

Inspiration, code snippets, etc.

* [dbader](https://github.com/dbader/readme-template)