jpbrickhouse / note-taker-express-server

An application to write, save, and delete notes. Uses an express backend to perform CRUD operations on data contained in a .json file, which mimics a more formal database.

Note Taker - Express Server

DESCRIPTION

For users that need to keep track of a lot of information, it's easy to forget or be unable to recall something important. Being able to take persistent notes allows users to have written information available when needed.

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

This application will use an express backend to save and retrieve note data from a JSON file database.

Visit the deployed application here: https://ancient-basin-96001.herokuapp.com/

SCREENSHOTS

Landing Page

NoteTaking Page

TABLE OF CONTENTS

• Installation
• Usage
• License
• Contributing
• Questions

INSTALLATION

• No installation is required, as the user can simply visit the deployed application link: https://ancient-basin-96001.herokuapp.com/
• However, if the user wishes to investigate the code locally, the following steps should be performed:
  • Clone the repo for use on your local machine
  • Use the command line to locate the cloned repo and make it your current directory
  • Type npm install in the command line
  • This will install the necessary node module packages and dependencies

USAGE

• To run the application locally...
  • Use the command line to locate the cloned repo and make it your current directory
  • Simply type node server.js in the command line
  • Executed correctly, the command line should respond with App listening on PORT: ####
  • Open your preferred browswer and visit http://localhost:####/
  • In both instances above, replace #### with the corresponding PORT number as noted in the server.js file
  • To end the server instance, simply type "ctrl" + "c"
• To run the application online, please visit the deployed link: https://ancient-basin-96001.herokuapp.com/
• Application functionality is identical whether you are running the server locally or visiting the deployed link:
  • After arriving at the landing page, please click "Get Started" to proceed
  • The next page - the "note-taking" page - consists of a sidebar, an entry form, and a navbar with buttons
  • Enter the note title and any corresponding text
  • To save the note, click the save button (a floppy disk icon)
  • Any saved notes will have their titles appear on the sidebar
  • To view the contents of a saved noted, click on the note title in the sidebar
  • To delete any notes saved on the sidebar, click the delete button (a trashcan icon)
  • To create a new note, click the compose button (a pencil icon)

LICENSE

License: MIT License
https://opensource.org/licenses/MIT

CONTRIBUTING

https://github.com/JPBrickhouse

QUESTIONS

Feel free to visit the following GitHub for more information: https://github.com/Username