Skip to content

SamagraX-Stencil/stencil-cli

Repository files navigation

Description

The Stencil CLI is a command-line interface tool that helps you to initialize, develop, and maintain your Nest applications. It assists in multiple ways, including scaffolding the project, serving it in development mode, and building and bundling the application for production distribution. It embodies best-practice architectural patterns to encourage well-structured apps.

The CLI works with schematics, and provides built in support from the schematics collection at @samagra-x/schematics.

Read more here.

Installation

$ npm install -g @samagra-x/stencil-cli

How to setup locally

Follow these steps to set up the project locally:

  1. Clone the project repository using the following command: git clone https://github.com/SamagraX-Stencil/stencil-cli.git

  2. Install the stencil-cli package by navigating to the cloned project directory and running: npm install

  3. Make any required changes to the project.

  4. Build the project by running: npm run build

  5. Run the following command in the stencil-cli cloned project directory: npm link

  6. Navigate to a new folder where you want to use the package locally.

  7. Run the following command to link the local version of stencil-cli: npm link @samagra-x/stencil-cli

Video Demo:

Samagra-x_stencil-cli.local.setup.demo.mp4

Usage

Learn more in the official documentation.

Stay in touch

Mentions

Stencil is powered by the following open source projects

  • [NestJS]
  • [Prisma]
  • [Prometheus]
  • [Grafana]
  • [Temporal]
  • [nestjs-temporal]
  • [nestjs-prometheus]

Pull Request Tests

License

Stencil is MIT licensed.