Get Mini up and running in your local machine 🚀

Last Updated on Feb 29, 2024 by Joeylene

TABLE OF CONTENTS

Setting up Locally

To setup MiniJS in your local machine, you can do the following:

1. Clone the repository.
2. Run yarn install to install dependencies.
3. Run yarn build to create the dist folder which is the bundled output for Mini.js.
4. Run yarn dev to run the demo page locally.
5. Run yarn build-watch on another terminal to build the files whenever the Mini.js code changes.
6. Run yarn test to run automated tests.

Release Setup

We use auto in automatically creating releases. When PRs or commits are pushed to the main branch, the GitHub action will trigger in which it will:

• Bump the version number based on the label of the PR:
  • patch - for updating version 1.0.x
  • minor - for updating version 1.x.0
  • major - for updating version x.0.0
• Commits that ends with [skip ci] will prevent the running the NPM Release action.
  • Example: Bump version 1.0.1 [skip ci]
• After release, it will add released tag to the PRs that were released.

Repositories

• main - production branch
  • GitHub Action: Will auto deploy new version of the npm package.
  • Suggested Flow: Create a PR of develop to main to group npm releases.