mydocker

MyDocker

Mydocker extends the capacity of ionic cli, providing an refined app exporting experience.

Shortlink https://git.io/fArWx

Table of Contents

• Introduction
• Installation
  • Supported Os
  • Requirements
  • Rubygems
• Usage
• Development
• Contributing
• License
• Code of Conduct

Introduction

MyDocker comes with a collection of short commands to work with docker, think it as a url shortener for docker, confusing? check it out!

Installation

Supported OS

• Mac
• Windows
• Linux

Requirements

• Ruby

Rubygems

Install it yourself as:

gem install mydocker

Configuration

1. Create a mydocker.yaml file, you can place it in any place, with this content:

---
projects:
  - project:
      name: "project-1"
      path: '/Users/demo-user/project-1'
  - project:
      name: "project-2"
      path: '/Users/demo-user/project-2'

Use this file to inform mydocker of your docker projects, add as many projects as you want and mydocker will provide help to these projects.

1. With Everything setup, open your command line and run

chris

It seems to be a strange command but there is a reason, later in this tutorial I explain to little more because chris is the mydocker main command.

1. Place your mydocker.yamllocation in the terminal then press enter

2. Now lets go to the next section on this documentation, why is chris so especial...

Usage

MyDocker provides these commands up to you:

chris up # Start project with docker-compose

Can be used to boot with a code editor too

chris up atom # Start project with docker-compose & open atom editor on the docker project

If youl'd like to stop project

chris down # Destroys project with docker-compose

If youl'd like to use docker cli on a specific container

chris cli

Provides access to a project container cli interface, if you do not provide any command bash will be used by default

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/gabriellacerda/mydocker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Runapk project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.