Skip to content
forked from kool-dev/kool

From local development to the cloud: development workflow made easy.

License

Notifications You must be signed in to change notification settings

leandroncbrito/kool

 
 

Repository files navigation

kool

Go Report Card docker

Development workspaces made easy

Dev environment made easy, a standardized way for running applications no matter the stack on your local machine and deploying it to a development environment.

Run any stack / tool with any version, powered by Docker and Docker Compose in a simple way avoiding you to install lots of stuff on your machine.

Have the same feeling working on multiple projects with different stacks.

Documentation

Full documentation at https://kool.dev/docs or at docs/.

Demo

kool - demo

Installation

Kool is powered by Docker and Docker Compose, you need to have it installed on your machine.

The run the follow script to install kool bin in your machine.

curl -fsSL https://raw.githubusercontent.com/kool-dev/kool/master/install.sh | bash

In case you need sudo:

curl -fsSL https://raw.githubusercontent.com/kool-dev/kool/master/install.sh | sudo bash

For Windows

Download the installer here

Usage

To help learning how to use kool we've built presets with good starting point for some popular stacks, feel free to open a PR in case you miss one.

Presets

Examples

You can see projects using it here: https://github.com/kool-dev/examples

Contributing

Like what you see? You are most welcome to contribute! We are working in a backlog of issues, feel free to browse through and enter discussions or get to work!

The flow is not written in stone, so you may go ahead and fork, code and PR with clear and direct communication on the feature/improvement or fix you developed.

PS: our main pain point at this moment is the lack of testing. Might be a great starting point.

Updating commands signature documentation

The Cobra library offers a simple solution for getting markdown documentation for usage of its commands. In order to generate update the generated markdown files do as follow:

cd docs
bash make_docs.sh
git add .
git commit -m "Updated commands docs"

Security

If you find security issue please let us know ahead of making it public like in an issue so we can take action as soon as possible. Please email the concern to [email protected].

License

The MIT License (MIT). Please see License File for more information.

About

From local development to the cloud: development workflow made easy.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 85.6%
  • Inno Setup 8.2%
  • Shell 5.1%
  • Other 1.1%