ianahart / note-taker

A note taking app to save notes. Created with Vanilla Js and Express js

Note Taker

Built With

• Node.js
• Express.js Framework

Description

This application allows the user to write down tasks or notes that they need to complete and have them saved. The project utilizes Node.js, and Express.js. Express js is a minimal unopionated web framework for creating REST APIs. The database is a JSON file where the server can interact with it, retrieving, adding and deleting notes.

Table of Contents

• Note Taker
  • Built With
  • Description
  • Table of Contents
  • Installation
  • Usage
  • Visuals
  • Tests
  • Credits
  • References
  • License
  • Contributing
  • Badges
  • Questions

Installation

• Download Node.js if not already installed

• Fork the repo to make a copy

  git clone https://github.com/ianahart/note-taker.git

• cd into the cloned project

• navigate into the root of the project where the package.json is located and run npm install to install necessary dependencies

Usage

From inside the project's root directory where the server.js file is located, run the command node server.js. You can now navigate in the browser to http://localhost:3001/ to get to the homepage. Click on get started. On the right hand side of the page you can type in a note title and text. Once they have been entered you can save the note and the new note will be added to the left side of the page. You can view each note by clicking on it or delete them by clicking on the trash can icon.

Visuals

https://hart-note-taker-a4b3f140a0f2.herokuapp.com/

Tests

N/A

Credits

Starter files and FrontEnd files provided by edX Boot Camps LLC.

References

• Express.js Documentation https://expressjs.com/
• UUID Npm Package https://www.npmjs.com/package/uuid

License

This project is covered under MIT License

License Text

Copyright (c) 2024  Ian Hart

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contributing

No contributions are being accepted at this time.

Badges

Questions

• Get in touch with me through email.
• Check out my GitHub profile.