@tul/shared-schematic

v1.1.0

Published

Shared schematics for saving time in develop process

Downloads

5

Readme

TUL

Shared schematics

These a schematics for Angular.

Description

We can create a Micro Frontend scaffold and config all you need. Saving time to initial settings project.

Bitbucket open pull requests LinkedIn

Table of Contents 📚

  1. Application Links 🔗
  2. Built With 🏗ī¸ 🚧
  3. Getting Started 🚀
    1. Prerequisites 👾đŸ’ģ👾
    2. Installation 🧱🔨👷đŸģ‍♀ī¸
  4. Usage 🛸🚀
    1. Commands 🎮🕹ī¸
  5. TODO List 📝

1. Application Links 🔗

  • Pakage manager 🧰

    • Npm library: "{{lib url}}"

2. Built With 🏗ī¸ 🚧

  1. Angular CLI v ~13.3.9
  2. Karma
  3. Node v.16.18.0
  4. Schematics CLI v ~13.3.9
  5. VS code We also recommend using Visual Studio Code as IDE.
  6. Node version manager (NVM)

3. Getting Started 🚀

To run the schematic, follow these simple example steps. Open the terminal or command prompt (CMD) and execute next commands.

3.1. Prerequisites 👾đŸ’ģ👾

  1. Intall NVM for multiple versions of Node.js.
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
  1. Install Node.js v16.18.0
nvm use 16.18.0
  1. npm - normally comes with Node. Run this to validate version.
node -v && npm -v
  1. Angular CLI

You need to install npm first and then angular cli with the following commands.

npm install -g @angular/cli@13
  1. Schematics-cli

You need to intall angular schematics cli to run command from anywhere dir.

npm install -g @angular-devkit/schematics-cli@13

3.2. Installation 🧱🔨👷đŸģ‍♀ī¸

  • Install [Shared schematic](npm link package) globally for run schema micro frontend app
npm install -g @tul/shared-schematic

4. Usage 🛸🚀

The following commands and instructions will help you know how to deploy or run functionalities locally.

4.1. Commands 🎮🕹ī¸

This commands are in the scripts of shared-schematic. open terminal and run:

  • With name like argument command line
schematics @tul/shared-schematic:mfe-app app_name
  • With name like schema value.
schematics @tul/shared-schematic:mfe-app --name=app_name
  • With x-prompt value
schematics @tul/shared-schematic:mfe-app

5. TODO list 📝

  • Defined a content for readme