Table of contents

1. Installation of Dependencies
2. Folder Structure
3. Folders and their Explaination
4. Usage
5. Features
6. Built with
7. Troubleshooting
8. Contact-Us

📥Installation of Dependencies

1. axios: A promise-based HTTP client for making HTTP requests.

npm install axios

2. yargs: A command-line interface framework for Node.js.

npm install yargs

3. enquirer: A collection of common interactive CLI prompts.

npm install enquirer

4.Use the package manager to install NPM.

npm install 

Usage:

• Yargs : It simplifies the creation of command-line tools in Node.js by offering a versatile and intuitive interface for defining commands, options, and arguments, empowering developers to build robust and user-friendly CLI applications effortlessly.

• Enquirer:Enquirer is a popular Node.js library for creating interactive command-line prompts. It allows you to easily create prompts for users to input data or make choices in a terminal environment.

📂Folder Structure

CLI-NPM-MUSIGMA
│---.gitignore
│---config.yaml
│---package-lock.json
│---package.json
│--- README.md
│
│
└── cli-musigma-bricks
    ├── bin
    │   └── mubrikcs.js
    │       
    ├── commands
    │   ├── features
    │       ├── mlops.js
    │       ├──nest_boilerplate.js
    │       ├──react_boilerplate.js
    │   
    ├── tests
    │   ├── create.test.js
    │   ├── interactive.test.js
    │   ├── show.test.js
    │       
    │
    ├── utils
        ├── clone.js
        ├── config.js
        ├── display.js
        ├── git.js
        └── versioning.js

📄Folders and their Explaination

Project Structure

CLI-NPM-MUSIGMA

The root directory of the project.

bin

Contains the main executable file for the CLI tool.

• mubrikcs.js: Main executable file for the CLI tool.

commands

Contains modules for various CLI commands.

features

Modules implementing features of the CLI tool.

• mlops.js: Implements functionality related to MLOps.
• nest_boilerplate.js: Implements functionality related to Nest.js boilerplate projects.
• react_boilerplate.js: Implements functionality related to React boilerplate projects.

tests

Contains unit tests for the CLI tool.

• create.test.js: Unit tests for the create command.
• interactive.test.js: Unit tests for interactive features.
• show.test.js: Unit tests for the show command.

utils

Contains utility modules used across the CLI tool.

• clone.js: Defines functions for cloning projects.
• config.js: Provides functionality for loading configuration.
• display.js: Implements functions for displaying information.
• git.js: Contains functions for interacting with Git.
• versioning.js: Implements versioning functionality.

.gitignore

Specifies files and directories to be ignored by Git.

config.yaml

Configuration file containing URLs and keys for various services.

package-lock.json

Auto-generated file that locks the dependencies version in npm.

package.json

Manifest file containing project metadata and dependencies.

README.md

Documentation file providing information about the project.

cli-musigma-bricks

Contains the main functionality of the CLI tool.

🔧Usage

• The NPM Console will work when the user hits mubricks command
• There are 3 features available create,show,interactive

mubricks create "project name"

mubricks show

mubricks Interactive

✨Features

Here're some of the project's best features:

• Interactive- This CLI Command help the user to naviagate interactively within the projects.
• Create-This CLI Command helps the user with creation of project in one shot(e.g-"mubricks create mlops")
• Show-This CLI Command help the user with various projects
• Interactive- This CLI Command help the user to naviagate interactively within the projects.

🛠Built with

Technologies used in the project:

• Node.js
• javascript

🔍Troubleshooting

If you encounter any issues during installation or execution, please check the following:

1. Ensure that all dependencies are correctly installed via Poetry.
2. Verify that the config.yaml file contains valid paths and settings.
3. Check the console output for error messages that may indicate what went wrong.
4. If you experience issues related to configuration, double-check the contents of the config.json file. Ensure that all URLs and keys are correctly specified.
5. Check the console output for any error messages that may provide insights into what went wrong during the build or runtime processes.
6. Feel free to report any bug in the GitLab.

📞Contact us

For any queries or support, reach out to us at [email protected].

Contributions to the project are welcome! Feel free to submit bug reports, feature requests, or pull requests.

We hope this README helps you effectively use the Code Quality SQL Tool to enhance your SQL scripts. Happy coding! 🚀