# gitfeatures

> A browser-based specification editor and feature toggle system that uses Git for version control

Latest version **0.0.1-alpha.22** (published 2021-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install gitfeatures
pnpm add gitfeatures
yarn add gitfeatures
bun add gitfeatures
```

Provides the command `gitfeatures`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.22 |
| Published | 2021-04-26 |
| First published | 2021-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 9.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Software Engineering & Consulting Pty Ltd |
| Maintainers | rolandq |
| Keywords | BDD, Specification, Feature Toggles, Feature Flags, Cucumber, Gherkin, Example Mapping, Markdown, Mermaid, Mindmap, Git |

## Links

- npm: https://www.npmjs.com/package/gitfeatures
- Repository: https://github.com/sengac/gitfeatures
- Homepage: https://github.com/sengac/gitfeatures#readme
- Issues: https://github.com/sengac/gitfeatures/issues
- npm.io page: https://npm.io/package/gitfeatures

## Dependencies (4)

- [open](https://npm.io/package/open.md) ^8.0.2
- [helmet](https://npm.io/package/helmet.md) ^4.4.1
- [express](https://npm.io/package/express.md) ^4.17.1
- [@isomorphic-git/cors-proxy](https://npm.io/package/@isomorphic-git/cors-proxy.md) ^2.7.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.1-alpha.22 (latest) — 2021-04-26
- 0.0.1-alpha.21 — 2021-04-17
- 0.0.1-alpha.20 — 2021-04-16
- 0.0.1-alpha.19 — 2021-04-14
- 0.0.1-alpha.18 — 2021-04-13
- 0.0.1-alpha.17 — 2021-04-12
- 0.0.1-alpha.16 — 2021-04-09
- 0.0.1-alpha.15 — 2021-04-08
- 0.0.1-alpha.14 — 2021-04-07
- 0.0.1-alpha.13 — 2021-04-06
- 0.0.1-alpha.12 — 2021-04-03
- 0.0.1-alpha.11 — 2021-03-29
- 0.0.1-alpha.10 — 2021-03-27
- 0.0.1-alpha.9 — 2021-03-26
- 0.0.1-alpha.8 — 2021-03-24
- … 8 more at https://npm.io/package/gitfeatures/versions

## README

# GitFeatures
[A browser-based specification editor for Behavior-Driven Development (BDD)](https://gitfeatures.com)

## Aim
To provide teams with a tool and concrete examples that help them intelligently develop software for agile projects.

## Features
- Mindmap-like interface
- Feature toggle management with feature nodes and auto-generated `features-toggles.yml`
- Custom conditions for feature toggles to power toggle flexibility
- Gherkin acceptance criteria editor (for feature files)
- Example maps as a node type - "story", "rule", "example", "question" to help develop acceptance criteria
- Browser-based Git for version control and persistence using [isomorphic-git](https://isomorphic-git.org/)
- PGP commit signing
- Support for document formatting using markdown
- Dynamically generated diagrams using [Mermaid](https://mermaid-js.github.io/)
- Render images and serve files from the browser's local Git repository
- Sketches can be saved in a markdown document

## Launcher Options
The command line launcher runs a Node Express server that contains a CORS proxy and a static file server that serves the bundled GitFeatures on a default port of 25921. When run with no options, it will also automatically open a browser and loads the app.

Running `gitfeatures --help` will display different options for the launcher:

```
Usage: gitfeatures [options]

Example: gitfeatures -c custom.json -t "My Spec" -d "My company: My specification drafting tool" -p 4999 -h "myspec.mycompany.com:4999" 

Options:
    -o true/false: automatically launch browser
    -c JSON configuration filename
    -t title: Page title
    -d description: Meta description
    -p port number: port number to listen on
    -h space separated list of allowed hosts in the Content Security Policy
```

## Tutorials
A selection of video tutorials can be found on the GitFeatures website: [https://gitfeatures.com](https://gitfeatures.com)

## Changing default configuration
GitFeatures stores its initial configuration settings in a `<meta name="gf:config" content="(urlencoded)">` meta tag in index.html. You can provide your own custom configuration by urldecoding the built-in tag content and passing it with the `-c` option on the launcher. This will then urlencode your configuration file and serve it.

## License
MIT License - (c) 2021 Software Engineering & Consulting Pty Ltd

---
_Source: https://npm.io/package/gitfeatures · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._