Giter Site home page Giter Site logo

note-taker's Introduction

License: MIT

Express Note Taker


front-page app


Table Of Contents


  1. Description
  2. Installation
  3. Usage
  4. Contributing
  5. Tests
  6. Review and Contribute

Description


This app utilizes an express server to allow a client to take, update, delete, and alter notes which are in turn saved to a json file which can be returned upon launch. The Note Taker utilizes several routes to deliver the base html to the client as well as api routes in order to handle the operations required of the note taker.


Installation


to install simply install the dependencies by using

npm i


Usage


Once all dependencies are installed you can run the program by inputting

npm start

in the command line. This will initialize the server. Once started, you can open up your browser and input

localhost:{PORT}

followed by the assigned port which is alerted in the command line upon launch. From there input a title and then input notes. Once finished, click the save icon in the top right corner. From there you will notice that the notes title has been stored in the left column along with a red trash can icon. From here you can either click on the note title itself to bring it up for editing or reading. Also, with the trash can icon, you can delete any note off of the database you so choose. These choices are updated dynamically making it easy for the client to modify them in real time.

You can also utilize the app on the heroku deployed site. This is much simpler as it is already served and one wouldnt need to clone the repo in order to test. The Heroku deployment link is listed below.


Contributing


licence attached to readme if interested in contribution. Github and email below.


Tests


test page of note taker


Github and Email


Review and contribute here

Github: cmgson

Deployment Information

This app has been deployed on Heroku.

Heroku Deployment click here

Here is where the deployment is located on Github.

screen cap


note-taker's People

Contributors

cmgson avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.