Peanut
πΊ Deploy Databases and Services Easily for Development and Testing Pipelines.
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- api.yml
- release.yml
- release_package.yml
- ui.yml
- boring-cyborg.yml
- CODEOWNERS
- dependabot.yml
- FUNDING.yml
- docker-compose
- install_etcd_ubuntu.sh
- install_rabbitmq_ubuntu.sh
- local_etcd_mac.sh
- local_etcd_ubuntu.sh
- release.sh
- test_script.sh
- .gitignore
- api.go
- configure.go
- deploy.go
- destroy.go
- license.go
- list.go
- root.go
- version.go
- health.go
- job.go
- metrics.go
- ready.go
- service.go
- tag.go
- workers.go
- base.go
- cassandra.go
- cassandra_test.go
- clickhouse.go
- consul.go
- consul_test.go
- elasticsearch.go
- elasticsearch_test.go
- etcd.go
- etcd_test.go
- etherpad.go
- ghost.go
- grafana.go
- grafana_test.go
- graphite.go
- graphite_test.go
- httpbin.go
- httpbin_test.go
- jaeger.go
- jaeger_test.go
- jenkins.go
- kafka.go
- mailhog.go
- mailhog_test.go
- mariadb.go
- mariadb_test.go
- memcached.go
- memcached_test.go
- minio.go
- minio_test.go
- mongodb.go
- mongodb_test.go
- mysql.go
- mysql_test.go
- nagios.go
- nagios_test.go
- postgresql.go
- postgresql_test.go
- prometheus.go
- prometheus_test.go
- rabbitmq.go
- rabbitmq_test.go
- redis.go
- redis_test.go
- registry.go
- vault.go
- vault_test.go
- zipkin.go
- zipkin_test.go
- db_interface.go
- etcd.go
- etcd_integration_test.go
- etcd_mock.go
- auth.go
- correlation.go
- cors.go
- log.go
- metric.go
- job.go
- job_test.go
- metric.go
- option.go
- option_test.go
- README.md
- service.go
- service_test.go
- base.go
- docker_compose.go
- docker_compose_test.go
- docker_hub.go
- docker_hub_test.go
- fuzzy_finder.go
- http.go
- http_test.go
- prometheus.go
- prompt.go
- helpers.go
- helpers_test.go
- map.go
- map_test.go
- shell.go
- shell_test.go
- docker-compose.yml
- README.md
- install.sh
- upgrade.sh
- .gitkeep
- loader.go
- server_mock.go
- job.go
- service.go
- chart.drawio
- chart.png
- logo.png
- screenshot_01.png
- screenshot_02.png
- screenshot_03.png
- screenshot_04.png
- 673.a1f88a72.css
- app.e9dfbb89.css
- chunk-vendors.053b6b6e.css
- logo.b0d08bb0.png
- 167.893f9c3f.js
- 167.893f9c3f.js.map
- 469.f08c0560.js
- 469.f08c0560.js.map
- 673.dc1c89fc.js
- 673.dc1c89fc.js.map
- 757.3e4a3a28.js
- 757.3e4a3a28.js.map
- 881.3f5d3418.js
- 881.3f5d3418.js.map
- app.82fc2188.js
- app.82fc2188.js.map
- chunk-vendors.e5622ebe.js
- chunk-vendors.e5622ebe.js.map
- index.html
- logo.png
- index.html
- logo.png
- logo.png
- api.service.js
- service.api.js
- .gitkeep
- index.js
- index.js
- service.module.js
- Deploy.vue
- Home.vue
- Login.vue
- NotFound.vue
- Services.vue
- App.vue
- main.js
- .env.dist
- .gitignore
- .prettierrc.json
- babel.config.js
- package-lock.json
- package.json
- .gitignore
- .go-version
- .goreleaser.yml
- .mergify.yml
- CODE_OF_CONDUCT.md
- config.dist.yml
- config.prod.yml
- config.toml
- CONTRIBUTING.md
- go.mod
- go.sum
- LICENSE
- Makefile
- peanut.go
- README.md
- renovate.json
- UPGRADE-0.3.0.md
# Installation Guide
1. Get the code
git clone https://github.com/Clivern/Peanut
Downloads the entire project code from GitHub to your computer.
cd Peanut
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ apt-get install docker.io -y
Type this command into your terminal and run it.
$ systemctl enable docker
Type this command into your terminal and run it.
$ apt-get install docker-compose -y
Runs the command against the services defined in the compose file.
driver: ${PEANUT_CONTAINERIZATION_DRIVER:-docker}
Type this command into your terminal and run it.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Node.js
EasyPrerequisites
$ npm install
Downloads and installs the libraries listed in package.json.
$ npm install -g npx
Downloads and installs the libraries listed in package.json.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
4. Go
MediumPrerequisites
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)