Giter VIP home page Giter VIP logo

genv's Introduction

A lightweight toolkit for local development with Docker

Build Status Coverage Status codecov

Genv makes it easy to run a local/offline development environment composed of Docker containers. It's an ideal choice for those that don't wish to run a full container management or orchestration platform on their workstation.

At its core, Genv is a set of bash scripts that provide an interface for running project-related tasks. Genv includes a collection of common services, which are essentially wrappers around Docker Compose configurations. All Genv services are designed to work together on a Docker network (named genv by default), with web-based services registering automatically with a proxy server (Traefik). The use of dnsmasq enables accessing services "externally" via one or more domains (.genv by default). Internal name resolution and service discovery (.service.int.genv) is supported with Consul and Registrator, as well as Docker's own internal DNS server.

Genv has been tested with:

Requirements

  • Bash 4 (bash) or ZSH (zsh)
    • macOS users should upgrade bash with Homebrew: brew install bash
  • Docker (docker)
  • Docker Compose (docker-compose)

Quick Start

  1. curl https://raw.githubusercontent.com/koinotice/genv/master/install.sh | bash
  2. Optional: Load completion scripts by adding which genv > /dev/null && . "$(genv initpath)" to your profile (~/.bashrc, ~/.bash_profile, ~/.zshrc).

TODO

  • Consul + Traefik tips
  • Documentation
    • Plugins
    • Bundled tasks

Contributing

  • If you experience an issue and are relatively certain that genv is the culprit, please report it.
    • Issues requesting support specifically for any of the core or supporting services will not be processed.
  • PRs are welcome ๐Ÿ™‚

genv's People

Contributors

bgetsug avatar mkleinsasser avatar koinotice avatar fentie avatar deesee04 avatar dolfelt avatar bvisness avatar zls avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.