Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 5.38 KB

README.md

File metadata and controls

103 lines (71 loc) · 5.38 KB
Raw

Quick Notes

A simple web application to note things down. Keeping it locally on Browser.

Note: This project has been bootstrapped with Create React App.

Dependencies

Trying Development Dependency

Syntactically Awesome Style Sheets (SASS) is a development dependency as was saved using --save-dev flag ('-D' for shorthand notation) with 'npm install'. It is included to support .sass and .scss SASS formats with Bootstrap. In case an .scss file has to be converted into its equivalent .css file, use npx sass <input.scss> <output.css> command. This is just suggested for assessment and is not needed to be separately done to setup files with these formats. For example, to check the .css source for src/App.scss file, use command npx sass src/App.scss src/App.css.

If 'sass' npm module is pre-installed globally (using '-g' flag with npm install command before), 'npx' command will not be needed and 'sass' can be directly used instead of 'npx sass'.

Features

Key highlights of this application are:

  • Add a new note
  • Edit, Delete a note
  • Copy a note to Clipboard
  • Delete all notes
  • Dark theme
  • Save notes locally on device with Browsers local storage
  • Sort all the existing Notes in ascending or descending order
  • Export Notes in JavaScript Object Notation (JSON) file format
  • Bulk Import Notes from Exported JavaScript Object Notation (JSON) file format

Usage

One-time setup

Install above dependencies, if haven't already. Prefer using the exact same versions as specified to guarantee source compatibility on device. Then, follow the given steps:

  1. Open a Terminal in the source directory.
  2. Run 
    npm install
    or npm i to install node module dependencies locally. To ensure clean installation with existing package-lock.json file present, use npm clean-install or npm ci to discard any module that is already installed in the project directory and newly install all dependencies.

Source assessment

Open a terminal in the source directory, and use below commands as intended.

  1. npm start

    or npm run start

    Runs the app in the development mode.
    Open http://localhost:3000/Quick-Notes to view it in browser.

    The page will reload on changes to any project file.
    Any lint errors will also be shown in terminal/console.

  2. npm test

    or npm run test

    Launches the test runner in the interactive watch mode.
    See the section about running tests for more information.

Source Build

If the above assessment seems fine and source is ready to be built into static files, use the below command in project directory:

npm run build

This builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
This App is ready to be deployed!

Built files deployment with a local static server

As homepage property is set to /Quick-Notes under package.json (in order to match deployment path on this dedicated GitHub Pages URL address for its source repository), directly serving from within the build directory with a static server will fail due to mismatching relative paths of linked scripts and stylesheets tied with the source. For this, copy files within or rename build folder itself to folder named "Quick-Notes", and start the server from the parent directory of this folder. Then, open <static-URL>/Quick-Notes to launch this web application. For example: If this static server has been started on localhost, then localhost/Quick-Notes should be able to load the site with all the generated files.

Servers such as npm serve and python3 -m http.server have been tried to load generated files for this project.

Additional references by React Documentation

This project is available in a ready state and may get development improvements. Contributions of all kind are welcome to this project. Go ahead and start a discussion, raise an issue or create a Pull Request. 🚀