Grounds is a 100% open source developer tool built to provide a way to share runnable snippets within various languages from a web browser.
Grounds is using a socket.io server to execute arbitrary code inside Docker containers, called grounds-exec. grounds-exec has its own repository here.
All you need is Docker 1.3+, Docker Compose 1.1+ and make to run this project inside Docker containers with the same environment as in production.
Grounds currently supports latest version of:
- C
- C++
- C#
- Elixir
- Go
- Haxe
- Java
- Node.js
- PHP
- Python 2 and 3
- Ruby
- Rust
Checkout this documentation to get more informations about how to add support for a new language stack.
Grounds is a Ruby on Rails web application.
Grounds is using the latest version of grounds-exec and will automatically pull the latest Docker image.
Grounds requires a Redis instance and will automatically spawn a Docker container with a new Redis instance inside.
git clone https://github.com/grounds/grounds.io.git
cd grounds.io
make pull
If you want to pull these images from your own repository:
REPOSITORY="<you repository>" TAG="1.0.0" make pull
REPOSITORY and TAG can be changed for convenience, however we strongly
recommend to use our official images with the latest tag incremental version.
Warning:
latesttag on the Docker hub matches the master branch of grounds-images.
Pulling all language stack images can take a long time and a lot of space. However, only ruby image is mandatory when running the test suite.
Pull a specific language stack image:
docker pull grounds/exec-ruby:latest
Checkout all available images on the official repository.
You need to specify a Docker remote API url to connect with.
export DOCKER_URL="https://127.0.0.1:2375"
If your are using Docker API through https, your DOCKER_CERT_PATH will be
mounted has a volume inside the container.
Be careful: boot2docker enforces tls verification since version 1.3.
make run
You can also run the web application in the background:
make detach
Or:
make
The web app should now be listening on port 3000 on your docker daemon (if you
are using boot2docker, boot2docker ip will tell you its address).
You can also run Grounds in production mode:
RAILS_ENV=production make run
When running in production mode, a default secret key is set as convenience, but this should be changed in production by specifying
SECRET_KEY_BASE.
If you want New Relic metrics you can also specify:
NEWRELIC_LICENSE_KEYNEWRELIC_APP_NAME
New Relic metrics are available only when running in production mode.
If you want Piwik web analytics you can also specify:
PIWIK_URL
Piwik web analytics are available only when running in production mode.
For ease of debugging, you can open a preconfigured environment inside a container with every services required to work with:
make shell
You can then launch common tasks like:
bundle exec rake run
bundle exec rake test
bundle exec rails console
bundle install
bundle update
Open a shell inside a container:
make shell
To install a new gem:
-
Edit
Gemfile -
Run bundle install
bundle install
To update existing gems:
bundle update
Both commands update Gemfile.lock, then next time that docker rebuild
the image, it will use this configuration to install these gems inside the
image.
Be careful: if you update the
Gemfilefirst, then trying to open a shell will fail, docker will try to rebuild the image with an outdatedGemfile.lock.
Tests will also run inside Docker containers with the same environment as the CI server.
To run the test suite:
make test
To run specific test files or add a flag for RSpec you can
specify TEST_OPTS:
TEST_OPTS="spec/models/ground_spec.rb" make test
Before sending a pull request, please checkout the contributing guidelines.
See authors file.
grounds.io is licensed under the MIT License. See LICENSE for full license text.