Skip to content

Kordrad/Confiks

Repository files navigation

A repository for the "confiks" package, allowing you to run the Command Line Interface (CLI) for easy and quick configuration of frontend projects with the required dependencies.

For detailed information about the CLI, please refer to the documentation here.

What will you find here?

The following section contains technical documentation only.

How to Run Locally

  1. Clone the project
git clone https://github.com/Kordrad/Confiks
cd .\Confiks
npm i
  1. Create build
npm run cli:build

or watch build

npm run cli:build:watch

Run demo

Remember! Build is required!

npm run cli:start

Manual start for other projects

Execute the following command:

# Provide a right path
node ..\Confiks\dist\packages\cli\src

Via NPM

  1. Open the path of the Confiks project
cd .\dist\packages\cli\
  1. Install globally
npm i -g .
  1. Run in the test project
confiks
# or
npx confiks

Commit Message Format

In the project, we use commit-lint with Conventional Commits based on Angular convention