dmpg-tools v0.0.3

dmpg-tools

An utility library for better productivities. https://dmpg-tools.netlify.com/

Folder Structure

src/
  source folder for the JavaScript functions
build/
  compiled and optimised bundle file of the library
website/
  website source folder
docs/
  Markdown files for documentations on the webiste

Library

Optimise and bundle the library

The library is compiled through Webpack with tools like Babel, this allows us to write JavaScript with the latest features and the final bundle file will still be ES5 compatible

// from the root folder
$ yarn run build

Deploy to NPM

// update version
$ npm version [patch|minor|major]
$ npm publish

Website

Serving the website locally

The accompanying documentation website is built with Docusaurus

// from the ./website folder
website $ yarn run start

Deploy the website to Netlify

Currently, the final static build of the website is hosted on Netlify, and the netlify config file can be find at ./website/.netlify

// from the ./website folder
website $ yarn run build
website $ netlify deploy

// or, combining build & deploy together
website $ yarn run build-publish

Misc

Library name dmpg-tools credits to David