Code Monkey home page Code Monkey logo

noteworthy's Introduction

Noteworthy

MIT

Description

Noteworthy is a note taking app that uses Express. Notes are stored in the cloud on the Express server so they can be accessed anywhere.

Heroku Link Live Deployment

Table of Contents

Installation

Noteworthy does not require any installation to use, you just need to enter the URL to the Express server in your browser to access the app. If you wish to view the code or contribute to the project, you would need to clone the Git repository to your local machine.

Usage

  1. Navigate your browser to the URL of the server, you will see the Noteworthy splash screen. 2) Click on the "Get Started" button and you will be taken to the notes page. If you have any existing notes already saved in the app, they will be displayed in the column along the left hand side.

To write a new note: Click on the pencil icon, you can then enter a note title and your note text in the text fields below. When your note is filled out, a Save icon will appear next to the Write icon. Click Save and your note will be saved to the Noteworthy server.

Viewing a Note: To view a note you have already written, click on the note you wish to view from the left-hand column. The note title and text will be displayed in the right-hand column for you to review.

Deleting a Note: To delete a note, click on the trash can icon next to the note you want to delete. NOTE: The note will be deleted without confirmation and cannot be restored once deleted! When you are done, you may close the browser or navigate away. Your notes will be available to you when you return.

License

This software is licensed under the MIT license.

Contribution

This project follows the guidelines of the Contributor Covenant. If you are interested in contributing, please contact me at my email in the Questions section of this README.

Questions

If you have any questions about this project, you can email me at [email protected]. For other projects, check out my GitHub.

noteworthy's People

Contributors

jdlawton avatar

Watchers

avatar

Forkers

lucaspittam kikolock

noteworthy's Issues

Project Setup

Initial project setup steps:

  • Download starter code
  • Create GH repo
  • Install needed modules, create directories, initial commits to repo
  • Review project criteria and create GH issues

Display existing Notes data

When the user clicks on "Get Started" on the initial splash screen, get the existing noes from the db.json file and display them in the left column.

Submission Checklist

  • Application front end must connect to an Express.js back end.
  • Application back end must store notes with unique IDs in a JSON file.
  • Application must be deployed to Heroku.
  • Application deployed at live URL.
  • Application loads with no errors.
  • Application console is free of errors.

Things to Submit:

  • The URL of the functional, deployed application. (Heroku)
  • The URL of the GitHub repository. Give the repository a unique name and include a README describing the project.

Initial server setup

Create the initial Express server

  • Create express server and test
  • Use localhost port 3333
  • Deploy to Heroku

**BONUS** - DELETE Notes

User can select a note to be deleted.

  • Find the id of the note the user clicked on to delete.
  • Read all the notes in db.json and find the note to be deleted.
  • Delete the note from db.json
  • Rewrite the remaining notes back to db.json

Create new Note

User enters new note in the title field and the note text field in the right column.

  • When a new title and note is entered, a save icon appears in the nav menu.
  • Clicking on the save icon, the new note is POSTed to the db.json file and then displayed in the column of notes on the left.

Write icon

Clicking on the write icon in the nav menu will clear any text in the text fields in the right column and ready the app to take a new note.

Code Cleanup / Breakout

  • Do any finishing code cleanup and any necessary breakout to break the code up into individual files to make it DRY.
  • Make sure input is validated and errors are caught / handled.
  • Update all instances of note-taker to noteworthy

Display Existing Notes

When user clicks on an existing note in the left column, the existing note title and text are displayed in the appropriate text fields in the right column.

  • Find the id of the note that was clicked on, then GET the note title/data and place them in the fields in the right column.
  • Not sure if I will need to read them from db.json or if I will be able to get the information from the element that is clicked on.

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.