npm-ui-component-test/README.md

./README.md

# Cadence Software Simple Button

Component: Simple-Button

## Development Process

```bash
# Validate Node is on version:
# v12.22.12
node -v

# Install NPM Packages
npm i

# Checkout main and pull
git checkout main && git pull

# Create a new branch for your changes
git checkout -b YourName/feature

# Open SNC UI Component
snc ui-component develop --open

# Make changes and commit them to the new branch
git add .
git commit -m "Added new feature"

# Push the new branch to the remote repository
git push origin YourName/feature

# Create a pull request to merge the new branch into main
```

### Notes

- Please do **not** push to the *main* branch
- Kill port for Unix (Mac / Linux) Users:
  - lsof -i :3000
- Start Development:
  - snc ui-component develop --open

### SNC Command Cheat Sheet

#### Most Useful Commands

```bash
# Creates a profile with the name specified
snc configure profile --profile [profile name]

# Creates a component
# Example
# snc ui-component project --name "cadence-side-menu" --scope "x_cadso_side_menu"
snc ui-component --name [name] --scope [scope] --description [description]

# Opens the component in your default browser
snc ui-component develop --open --profile [profile name]

# Deploys the component to your specified profile's instance if you have permissions to do so.
# Force argument is for redeployment
snc ui-component deploy --profile [profile name] --force
```

#### SNC Commands
```bash
# Configure
snc configure

# Profile
snc profile

# Extension
snc extension
```

#### UI-Component
```bash
# Deploy
snc ui-component deploy

# Project
snc ui-component project

# Development
snc ui-component develop
```