Note Taker

This application enables the user to write, save, and delete notes on a to-do list.

Getting Started

All of the files can be loaded with your browser. Copy the files to your local directory, open a Git Terminal and type "node server.js". Then open a browser and navigate to localhost:3000.

Prerequisites

• A browser. Chrome was used for testing.
• [Git terminal] https://git-scm.com/downloads

Installing

1. Go to https://github.com/ruthtech/note-taker and click on the "Clone or Download" button. 
2. Choose "Download ZIP". 
3. Unzip into a directory. If you're on Windows, open File Explorer and navigate to the download directory. Select the ZIP file, right click, and choose "Extract All". Accept the default location.
4. Once the file is unzipped, navigate to note-taker-master and use your browser to open index.html.
5. Install the prerequisites through your Git Terminal:
      * express (type npm install express)
      * JEST (type npm install jest)

Running the tests

Type "npm test" in your Git terminal to run the automated test suite.

Manual tests (for the UI)

First start the server via your Git terminal:

1. node server.js

Then open a browser on "localhost:3000":

1. User opens the note taker and looks at the notes that already exist.
2. User adds a note.
3. User deletes a note.

To view the result of the tests without running them yourself, watch below:

Deployment

Because this application requires a live server, there is no live demo at this time. Copy the files to your computer, start the server, and view localhost:3000. Alternatively, view the animated GIF in the "Running the tests" section.

Built With

• [Visual Studio Code] https://code.visualstudio.com/docs/setup/setup-overview
• [Visual Studio Code Extension "Open in Browser"]
  • Open VS Code.
  • Open the extensions pane and search for open in browser.
  • Select the version written by TechER and click Install.
• [Google Chrome] (https://www.google.com/chrome/browser/desktop/index.html)
• Eclipse (https://www.eclipse.org/downloads/)
• npm tools:
  • JEST
  • Express
• U of T Coding Bootcamp wrote the UI code in this package (uses Bootstrap and fontawesome):
  • [Bootstrap] https://getbootstrap.com/
  • [Font Awesome] https://fontawesome.com/v5.3.1/icons?d=gallery
• Git terminal

Contributing

This project is not open to contributions.

Versioning

This project does not use versions at this time.

Authors

Ruth Lee

License

MIT

Acknowledgments

Thanks to the following:

• [U of T Coding Bootcamp] https://bootcamp.learn.utoronto.ca/coding/ They wrote the UI code in this package.