Development engine for Kubernetes, containers and serverless functions.
Clone or download
drubin Merge pull request #375 from garden-io/docs-remove-reference
docs: revert config and command file that added -reference
Latest commit f460726 Nov 16, 2018
Permalink
Failed to load latest commit information.
.chglog chore(changelog): use git-chglog for changelog gen and fix CHANGELOG.md Oct 7, 2018
.circleci chore(tests): add go tests to ci Nov 7, 2018
bin refactor(error-messages): improve error message for check-docs Nov 5, 2018
docs docs: revert config and command file that added -reference Nov 16, 2018
examples feat: added --hot-reload flag to dev & deploy Oct 16, 2018
garden-cli chore(tests): add go tests to ci Nov 7, 2018
garden-service docs: revert config and command file that added -reference Nov 16, 2018
garden-sync refactor(go-cli): use docker sdk and keep containers running Nov 2, 2018
support fix: fix broken doc links Nov 2, 2018
.editorconfig First commit, woop woop! Jan 11, 2018
.gardenignore fix: version is now correctly set for plugin modules (#84) May 14, 2018
.gitbook.yaml docs: add Gitbook config file May 31, 2018
.gitignore feat: experimental single-binary build via zeit/pkg Oct 28, 2018
.npmignore chore: correctly configure for npm release May 31, 2018
.nvmrc chore: switch development node version to 10.11 Oct 30, 2018
.nycrc refactor: major overhaul to plugin architecture Apr 18, 2018
.snyk chore: update to TypeScript 3.0 Aug 21, 2018
CHANGELOG.md chore(release): update changelog Nov 1, 2018
CODE_OF_CONDUCT.md Added code of conduct and a bit of documentation on contribution Apr 5, 2018
CONTRIBUTING.md docs: update release process docs Nov 1, 2018
Gopkg.lock refactor(go-cli): use docker sdk and keep containers running Nov 2, 2018
Gopkg.toml feat(cli): experimental go frontend CLI Oct 25, 2018
LICENSE.md Added license and automated license checker Apr 5, 2018
README.md fix: fix broken doc links Nov 2, 2018
commitlint.config.js chore: switch to commitlint to validate commit messages Jun 5, 2018
gulpfile.ts feat(cli): experimental go frontend CLI Oct 25, 2018
lerna.json chore(release): update docs and Windows installation script Oct 28, 2018
package-lock.json chore(ci): add automatic link checking for markdown Nov 2, 2018
package.json refactor(build): remove dependancy on git submodule for k8s Nov 5, 2018
tsconfig.base.json feat: experimental single-binary build via zeit/pkg Oct 28, 2018
tsconfig.json chore: re-arrange repo to have garden-cli package in sub-directory Jul 19, 2018
tslint.json fix: handle all promises and add no-floating-promises linting rule Sep 25, 2018

README.md

CircleCI

Welcome! Garden is a full-featured development framework for containers and serverless backends, designed to make it easy to develop and test distributed systems.

Status

The project is in early alpha (or developer preview, if you prefer). This means APIs may well change (not drastically, but still), overall stability will improve and platform support is still limited.

All that said, Garden can already be highly useful if the following applies to you:

  • You're deploying to (or transitioning to) Kubernetes.
  • You work mostly with containers today (but perhaps plan on adopting serverless platforms in the future).
  • You really don't want to spend your precious hours building your own developer tooling!

If that sounds right for you, please give it a go and don't hesitate to report issues.

Features

With Garden, you can...

  • Configure and deploy a fleet of services to a local Kubernetes cluster using simple declarations.
  • Use an integrated framework for building, testing and deploying services.
  • Easily run end-to-end tests across multiple services without waiting for a slow CI pipeline.
  • Automatically build, deploy and/or test when your code changes, using the --watch flag or the garden dev command.
  • Manage build and runtime dependencies across all your services.
  • Leverage a suite of commands and helpers to facilitate developing and running your stack.
  • Write code the way you want, and run your production system however suits you! Garden does not impose any new libraries or languages aside from the config files.

Garden is also designed to be pluggable and modular, with Kubernetes being just one plugin (albeit an important one). Over time we will add native support for a variety of platforms, including AWS (Lambda, ECS, Fargate and more), GCP, Heroku, OpenFaaS... and the list will continue growing.

Please read the Motivation section in our documentation for a brief discussion on why we're building Garden.

Usage

Head over to the Basics section in our documentation for details on how to set up and use Garden, or look through our Simple Project guide to get a quick sense of how it works.

asciicast

Contributing

We welcome any and all contributions to Garden! What we're trying to achieve is a big task, and developers have a lot of diverse needs, so we need and appreciate your input, whether it's through code, docs, issues or developing plugins for your needs.

For more detailed guidelines, see CONTRIBUTING.md.

License

Mozilla Public License 2.0 (MPL-2.0)