Archus Components Web

This is the repository for the ERP archus-components-web server.

• Tech Stack
• Prerequisite
• Setting Up
  • Visual Studio Code Dev Container
• Deployment
  • Publishing
• Usage
  • Installing on Another Project

Tech Stack

• NodeJS 16.x.x
• Docker
• Git
• GitHub Actions

Prerequisite

• Visual Studio Code
  • Should be installed.
  • Dev Container extension should be installed.
• Docker
  • Should be installed and running.
  • CPU should be configured to be 6 or more.
  • Memory should be configured to be 8GB or more.
• Git
  • Email and Name should be configured.
• GitHub Personal Token (.ssh file on ~/ user home directory)
  • Generate a GitHub SSH Key.
  • Name your SSH key file as .ssh.
• NPM Runtime Configuration (.npmrc file on the ~/ user home directory)
  • Create a .npmrc file using your Generated Personal Access Token.

    @thepiquelab:registry=https://npm.pkg.github.com/
    //npm.pkg.github.com/:_authToken=<replace_with_your_access_token>

Setting Up

Run this project using Visual Studio Dev Container.

Visual Studio Code Dev Container

• Checkout the archus-components-web project.
• Open the project in Visual Studio Code.
• Install the suggested extension(s).
• Hit Cmd + Shift + P then type and select Dev Container: Reopen in Container.
• Wait for the process to complete.
• Run yarn install to install the depependencies.
• Run the project by running yarn dev from the terminal.

Deployment

Publishing

migrated from [TECH] Getting Started After updating, modify the version in the package.json.

{
    "name": "@thepiquelab/archus-components-web",
    "version": "1.3.8", -> "1.3.9"

Commit and push as usual. Do not run npm publish locally.

After your pull request is merged into master, go to this repository's Code -> Releases page and click Draft a new release Create a new tag as the same string as the new version value in package.json and use it as the tag for the release. Use the same value in the Release title. Finally, click Publish Release.

Usage

Installation on Another Project:

npm install @thepiquelab/archus-components-web