https://github.com/stacker/stacker-cli

Docker Compose Templates
https://github.com/stacker/stacker-cli

cli devops docker docker-compose stacker

Last synced: about 1 month ago
JSON representation

Docker Compose Templates

• Host: GitHub
• URL: https://github.com/stacker/stacker-cli
• Owner: stacker
• License: mit
• Created: 2017-03-07T15:10:13.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-27T09:58:13.000Z (over 7 years ago)
• Last Synced: 2024-10-27T22:18:09.386Z (about 2 months ago)
• Topics: cli, devops, docker, docker-compose, stacker
• Language: JavaScript
• Homepage:
• Size: 50.8 KB
• Stars: 67
• Watchers: 6
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-docker - Stacker - Docker Compose Templates. Stacker provides an abstraction layer over Docker Compose and a better DX (developer experience). (Container Operations / Container Composition)
• awesome-docker - Stacker - Docker Compose Templates. Stacker provides an abstraction layer over Docker Compose and a better DX (developer experience). (Container Operations / Container Composition)

README

        
Stacker

=======

[![Twitter Follow](https://img.shields.io/twitter/follow/StackerHQ.svg?style=social?maxAge=2592000)](https://twitter.com/StackerHQ)

[![Version](https://img.shields.io/npm/v/stacker-cli.svg)](https://www.npmjs.com/package/stacker-cli)

[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/stacker/stacker-cli/blob/master/LICENSE)

[![dependencies](https://david-dm.org/stacker/stacker-cli.svg)](https://david-dm.org/stacker/stacker-cli)

[![devDependency Status](https://david-dm.org/stacker/stacker-cli/dev-status.svg)](https://david-dm.org/stacker/stacker-cli#info=devDependencies)

> Docker Compose Templates

Stacker is a simple tool for defining application environments, aka *stacks*. Each stack is optimized for **development** and for **production** use as well. Stacker is built on top of Docker and Docker Compose as an abstraction layer. The main paradigm followed in designing Stacker was **convention over configuration**.

## :tv: Demo

  

    

      

    

    

      

    

  

  

    Laravel

    Wordpress

  

## :checkered_flag: Installation

> Requirements: `node 6+`, `docker 17+`, `docker-compose 1.10+`. Tested succesfully on Mac OS and Ubuntu.

Install the CLI app globally using NPM.

```bash

# install stacker

npm install -g stacker-cli

# make sure it's working

stacker --version

```

## :fire: Getting Started

Before going further, make sure you `cd` into the root path of your project (`cd ~/Projects/test-project`).

1. **Generate the `stacker.yaml` file**

    ```bash

    $ stacker init

    ```

    If your project already has a `stacker.yaml` file, this step is not required.

2. **Setup the project on your local machine**

    ```bash

    $ stacker link

    ```

    This will do several things

    - create a local IP alias (eg. `127.20.17.1`)

    - setup your chosen domain name in `/etc/hosts`

    - add the project to the projects list

3. **Build and start your application**

    ```bash

    $ stacker up

    ```

    After this you will be able to reach your application using the domain name you choose previously. (eg. `test-project.dev`)

## :hand: Add your favorite stack!

Is your stack missing? Please open an issue and we'll take care of it. Since we're not experts in all stacks, your input and guidance will be helpful to make a top notch stack. For the moment, we will keep all the stacks inside the official repos just to make sure they all follow best practices.

Here is a list of the stacks we want to add with your help: Symfony, Ruby on Rails, Django, Meteor, Play, Ghost. If you have other stacks in mind just let us know.

## :memo: Documentation

For full CLI reference, checkout the [DOCUMENTATION.md](DOCUMENTATION.md) file.

## :scroll: License

MIT @ [Stacker](https://twitter.com/StackerHQ)