/note-taker

AS A small business owner I WANT to be able to write and save notes SO THAT I can organize my thoughts and keep track of tasks I need to complete

Primary LanguageJavaScript

Note Taker Application

Table of Contents

Description

This application allows small business owners to write and save notes of their choice to keep track of important taskwork.

Features

This application was built with the following features:

  • HTML
  • CSS
  • Javascript
  • Express.js
  • Uniqid (Npm package)

User Story

  • AS A small business owner
  • I WANT to be able to write and save notes
  • SO THAT I can organize my thoughts and keep track of tasks I need to complete

Acceptance Criteria

GIVEN a note-taking application

  • WHEN I open the Note Taker THEN I am presented with a landing page with a link to a notes page
  • WHEN I click on the link to the notes page THEN I am presented with 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
  • WHEN I enter a new note title and the note’s text THEN a Save icon appears in the navigation at the top of the page
  • WHEN I click on the Save icon THEN the new note I have entered is saved and appears in the left-hand column with the other existing notes
  • WHEN I click on an existing note in the list in the left-hand column THEN that note appears in the right-hand column
  • WHEN I click on the Write icon in the navigation at the top of the page THEN I am presented with empty fields to enter a new note title and the note’s text in the right-hand column

Installation

To install this application, complete the following steps:

  1. In your web browser, enter the following link: https://github.com/jlcunningham2101/note-taker
  2. Click 'Code' and copy the GitHub repository
  3. In the Visual Studio Code terminal, navigate to the location on your computer where you'd like to save the file
  4. In the command line, enter ' git clone https://github.com/jlcunningham2101/note-taker '
  5. In the command line, type ' npm i ' to install the dependencies required to run this application

Usage

The following steps will assist with user access to this application:

  1. In the terminal of your Visual Studio Code, type 'npm start.' This will jump start the server.
  2. In your web browser, type the following link: http://localhost:3001/
  3. To add a note, click the '+' icon in the top right hand corner of the application, enter your 'Note Title" and 'Note Text'
  4. To delete a note, click the red trash can icon associated with the note you'd like to remove.

Webpage Screenshots

Image of the notetaker homepage: Screenshot

Image of how users can create a note: Screenshot

GitHub URL

https://jlcunningham2101.github.io/note-taker/ https://github.com/jlcunningham2101/note-taker

Contributor

If there are questions and/or concerns about this application, then feel free to reach out using my contact details below: Name: Jill Cunningham Email: jleighcunningham@gmail.com GitHub URL: https://github.com/jlcunningham2101