https://github.com/psmyrdek/rmcatalog-feature-config

https://github.com/psmyrdek/rmcatalog-feature-config

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/psmyrdek/rmcatalog-feature-config
• Owner: psmyrdek
• Created: 2024-03-26T09:39:08.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-03-26T19:06:39.000Z (10 months ago)
• Last Synced: 2024-11-22T03:42:13.690Z (2 months ago)
• Language: HCL
• Size: 17.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# example-yml

Basic example showing how Featurevisor works, with all definitions written in YAML.

Visit [https://featurevisor.com](https://featurevisor.com) for more information.

## Initialize

```

$ mkdir my-featurevisor-project

$ cd my-featurevisor-project

$ npx @featurevisor/cli init --example example-yml

```

## Installation

```

$ npm install

```

## Usage

### Lint YAMLs

```

$ npm run lint

```

### Build datafiles

```

$ npm run build

```

### Test features

```

$ npm test

```

### Start local server

Generates and serves status site:

```

$ npm start

```

### Generate code

For additional type safety and autocompletion, you can generate TypeScript code from your YAMLs:

```

$ npm run generate-code

```

See output in `./src` directory.

You may choose to publish the generated code as a private npm package and use it in multiple applications.