JavaScript Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
packages
.gitignore
.travis.yml
CLA.pdf
CONTRIBUTING.md
LICENSE
README.md
lerna.json
logo.png
package-lock.json
package.json

README.md

A declarative boilerplate generator designed to help you write less meaningless code.

npm Travis Coveralls

Installation

CLI

> npm i -g npx
> npm i --save-dev cyto-cli
# Add this line to your .bash_profile / .bashrc / other
> alias cyto='npx cyto'

Npx isn't technically required, but it makes running Cyto much simpler. More discussion on this can be found here

Library

The cyto-core package can be used in a node.js app as a standalone library, but this feature is currently untested and the API is still not entirely stable. This will be updated when the functionality is fully supported.

Docs

  1. Getting Started
  2. Argument Types
  3. Composing Templates
  4. Creating Your Own Template
  5. Runtime Dependencies
  6. Partial Templates
  7. Base Templates
  8. Template Options
  9. Best Practices
  10. API Reference

Contributing

  1. Read the docs on contributing here and sign the CLA
  2. Clone this repository
  3. Run npm i

Contributors

Cyto is written and maintained by Connor Taylor @taylorc93. However, it wouldn't have been possible without the help of these amazing people:

  1. Scott Staniewicz scottstanie
    • For all of the documentation edits and user testing
  2. Alicia Payette apayette
    • For designing the awesome logo
  3. Alex Kasemir alexkasemir
    • For documentation edits and user testing
  4. Anna Richardson annarichardson
    • For user testing