https://github.com/cogolabs/cyto

A declarative boilerplate generator
https://github.com/cogolabs/cyto

boilerplate cyto generator javascript mustache templates

Last synced: about 1 month ago
JSON representation

A declarative boilerplate generator

• Host: GitHub
• URL: https://github.com/cogolabs/cyto
• Owner: cogolabs
• License: apache-2.0
• Created: 2017-04-24T19:18:00.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-06T19:05:01.000Z (over 6 years ago)
• Last Synced: 2024-05-02T10:21:32.540Z (8 months ago)
• Topics: boilerplate, cyto, generator, javascript, mustache, templates
• Language: JavaScript
• Homepage:
• Size: 1.48 MB
• Stars: 12
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


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

[![npm](https://img.shields.io/npm/v/cyto-core.svg)]() [![Travis](https://img.shields.io/travis/cogolabs/cyto/master.svg)]() [![Coveralls](https://img.shields.io/coveralls/cogolabs/cyto.svg)]()

## Installation

#### CLI

```bash

> 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](docs/npx.md)

#### 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](docs/gettingStarted.md)

2. [Argument Types](docs/arguments.md)

3. [Composing Templates](docs/composing.md)

4. [Creating Your Own Template](docs/creatingTemplates.md)

5. [Runtime Dependencies](docs/runtimeDependencies.md)

6. [Partial Templates](docs/partialTemplates.md)

7. [Base Templates](docs/baseTemplates.md)

8. [Template Options](docs/options.md)

9. [Best Practices](docs/bestPractices.md)

10. [API Reference](docs/reference.md)

## Contributing

1. Read the docs on contributing [here](CONTRIBUTING.md) and sign the CLA

1. Clone this repository

1. Run `npm i`

## Contributors

Cyto is written and maintained by Connor Taylor [@taylorc93](https://github.com/taylorc93). However, it wouldn't have been possible without the help of these amazing people:

1. Scott Staniewicz [scottstanie](https://github.com/scottstanie)

    - For all of the documentation edits and user testing

1. Alicia Payette [apayette](https://github.com/apayette)

    - For designing the awesome logo

1. Alex Kasemir [alexkasemir](https://github.com/alexkasemir)

    - For documentation edits and user testing

1. Anna Richardson [annarichardson](https://github.com/annarichardson)

    - For user testing