Skip to content

Latest commit

 

History

History
117 lines (80 loc) · 3.78 KB

README.md

File metadata and controls

117 lines (80 loc) · 3.78 KB
Raw

note-it-js

Virtual version of the famous sticky paper note solution.

Setup / Contribute

The development of this projects requires the installation of a node.js environement. Install node.js for your OS distribution — as an alternative you can install and use nvm, to manage multiple node.js versions.

With node.js comes npm, the Node Package Mananger — as an alternative you can also use yarn.

  • clone this git repository
  • cd note-it-js
  • npm install to install the dependencies described in the package.json file

Run de development server

Inside the project's folder:

  • Be sure that you have installed all javascript dependencies with npm install
  • Start a development server with the command npm start

The command output should say on which local URL and port the development server is accessible.

When the server is running, all changes to the project's assets are detected. It will result in the server building a new version of each changed assets and refreshing the web page to display all changes.

Testing, linting, Continuous Integration

Linting

For Linting, this project uses the opinionated Prettier. It is setup to run with Pre-commit tools (as in pre-commit hooks), to re-format all files that are marked as "staged" via git add before they are commited. For more information, read Prettier pre-commit hooks documentation.

You can also run the npm run lint command at any time.

Continous Integration (CI)

CI is setup using travis-ci.

Build the project for production

To build the project, use npm run build.

This command will create a production ready folder ./dist containing all assets required to run the project live.

Serve the content of this folder with entry point the index.html file.

To test locally, run the command npm run serve-build, which will just create a server, serving the production files from the ./dist folder. This command is only meant for this precise purpose, to simulate how to right files are served to the final users.

Releases

If your only interested in the final .js, have a look at the release page: https://github.com/inofix/note-it-js/releases

Examples / Demo

Running examples can be found here: https://note-it-js.demo.inofix.net/

Perspectives

We also have a Liferay-Portlet featuring note-it-js at https://github.com/inofix/ch-inofix-sketch-board.

Notes

On the development server

This projects uses parcel.js (see getting started for more details) as web application bundler. It is used to run a development server and build the production version of the project.

During the development phases, it watches for changes to the different assets files and folders, to update the development version of the application.

During production, it bundles and minifies the same assets (when possible or needed).

It is using parcel-plugin-static-files-copy to copy the static files (images etc.), that are located in the ./static folder, into the dist folder, for it to be production ready.

On the production build

During the build for production phase, assets (js, css, html etc.) are minified by the application bundler (and its chain of "transforms" — see its documentation).

The .htmlnanorc file specifies "minifySvg": false, since the minification step of the svg DOM element in the ./index.html was causing to remove its id; therefore leading to the javascript application not starting, because this element (the svg root used by d3) could not be find by its id.