Git Product home page Git Product logo

notewise's Introduction

NoteWise

By Said-cmd

Link to deployed site

https://note-wise.herokuapp.com/

Description

This project is a web application that allows users to have a note taking app on the web. Designed to mimic physical sticky notes, users can add notes, delete notes and search through their notes for specific entries. The notes are also ordered by date added which is automatically attached to footer of each note once it's generated. There's also a dark mode feature which allows the user to change the color of the site depending on their preference.

Features

How to use the webpage

Once the page has fully loaded, navigate to the sticky note at the end of the list (which is in the darkest shade of blue with an add icon and an "Add a note...' placeholder). Type in whatever note it is you would like to enter and click the plus icon to add it to your list of notes. To delete any note simply, tap the delete icon (bin icon). And finally filter through your exisiting notes for a specific entry using the search bar at the top of the page. Toggle dark mode on and off depending on your preference by tapping the toggle icon at the top of the screen.

Users of the application will be able to:

  • Add a note
  • Delete a note
  • Search through their notes for a specific entry
  • Toggle the site to dark mode depending on preference

Requirements

  • Internet access
  • A computer with a compatible browser

Installation Process

Clone this repo locally using the format: git clone https://github.com/Said-cmd/NoteWise

Unzip the downloaded files and open them in a text editor of your choice.

Run npm install to install the node modules and package dependancies.

Run json-server --watch db.json assuming you have the json-server installed globally to the the server.

Since we have a key of notes poiting to an array of note entries, the json-server will generate the following routes:

  • GET /notes - when you load the site.
  • POST /notes - whenever you add a new note.
  • DELETE /notes/:id - whenever delete a note.

Technologies Used

  • HTML - used to structure the webpage.

  • CSS - used to style the user interface and the webpage as a whole.

  • JavaScript- used to make the webpage responsive.

  • React.js - used to build the entire user interface allowing for a single page web application.

  • JSON - used as the data exchange format.

License

MIT License

Copyright (c) [2022] [Said-cmd]

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.

Author

GitHub: https://github.com/Said-cmd

notewise's People

Contributors

said-cmd avatar

Watchers

 avatar

Forkers

josephbill

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.