Skip to content

marycpriyanka/note-taker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Note Taker

badge

Description

Note Taker is an application used to write, save and delete notes. This is very useful to all types of users like small business owners, so that they can organize their thoughts and keep track of tasks they need to complete. This application will use an Express.js back end and will save and retrieve note data from a JSON file.

Table of Contents

Installation

This program can be run through a browser using the link to the deployed application. Alternatively, to run this application locally you will need to:

  • Clone this repository to receive all of the files
  • Run npm install in the command line of your terminal to set up all of the dependencies
  • Run node server to start the application's connection
  • Go to the url of the application (http//:localhost:3001) to begin using it

Usage

Use the live Heroku URL to open the deployed application. You will be presented with a landing page with a link to notes page.

initialPage

Click on the link to the notes page. Then user will be presented with a page with existing notes listed in the left hand column, plus empty fields to enter a new note title and note's text in the right hand column.

notes

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

save

Clicking the Save icon will save the new note entered. The saved note will then appear in the left hand column with the other existing notes.

saved

User can delete any existing note by clicking on the Delete icon next to the respective note title in the list in the left hand column. If user clicks on an existing note in the left hand column, that note will appear in the right hand column. When the Write icon or the + icon in the navigation at the top of the page is clicked, then user is presented with empty fields to enter a new note title and the note's text in the right hand column.

Technologies used

Node.js, Express.js, HTML

License

Note Taker is available under the MIT License.

How to Contribute

Contributions and ideas are welcome. Before submitting an issue, please take a moment to look over the contributing guidelines in https://www.contributor-covenant.org/ . Before submitting pull requests, ensure the following:

  • Fork the repo and create your branch from main.
  • Test your code.

Deployed link

https://pacific-caverns-10678.herokuapp.com/

Questions

https://github.com/marycpriyanka

For any addditional questions, reach me at marycpriyanka@gmail.com.

About

Note Taker is an application used to write, save and delete notes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published