{"id":13451476,"url":"https://github.com/eko/monday","last_synced_at":"2025-04-13T02:00:07.565Z","repository":{"id":37561569,"uuid":"196212778","full_name":"eko/monday","owner":"eko","description":"⚡️ A dev tool for microservice developers to run local applications and/or forward others from/to Kubernetes SSH or TCP","archived":false,"fork":false,"pushed_at":"2025-04-06T20:29:53.000Z","size":17211,"stargazers_count":1346,"open_issues_count":0,"forks_count":43,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-13T01:59:49.663Z","etag":null,"topics":["architecture","development","development-tools","devops","hacktoberfest","kubernetes","microservice","ssh","tcp"],"latest_commit_sha":null,"homepage":"https://vincent.composieux.fr/article/how-does-monday-use-go-and-how-does-it-work/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["eko"]}},"created_at":"2019-07-10T13:42:53.000Z","updated_at":"2025-04-06T20:29:54.000Z","dependencies_parsed_at":"2023-12-14T22:54:31.055Z","dependency_job_id":"4cd724c6-2883-4f42-8b00-4ede107ebbf0","html_url":"https://github.com/eko/monday","commit_stats":{"total_commits":257,"total_committers":11,"mean_commits":"23.363636363636363","dds":"0.49027237354085607","last_synced_commit":"82ee91d18b8a1c48a21f2793235d6cf5a8969304"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eko%2Fmonday","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eko%2Fmonday/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eko%2Fmonday/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eko%2Fmonday/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eko","download_url":"https://codeload.github.com/eko/monday/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654046,"owners_count":21140235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture","development","development-tools","devops","hacktoberfest","kubernetes","microservice","ssh","tcp"],"created_at":"2024-07-31T07:00:54.432Z","updated_at":"2025-04-13T02:00:07.535Z","avatar_url":"https://github.com/eko.png","language":"Go","readme":"\u003ch1 align=\"center\"\u003e\u003cimg src=\"misc/logo.jpg\" title=\"Monday: dev tool for local app and port-forwarding\" alt=\"Monday: dev tool for local app and port-forwarding\"\u003e\u003c/h1\u003e\n\n![Test (master)](https://github.com/eko/monday/workflows/Test%20(master)/badge.svg)\n[![GoDoc](https://godoc.org/github.com/eko/monday?status.png)](https://godoc.org/github.com/eko/monday)\n[![GoReportCard](https://goreportcard.com/badge/github.com/eko/monday)](https://goreportcard.com/report/github.com/eko/monday)\n\nYour new microservice development environment friend. This CLI tool allows you to define a configuration to work with both local applications (Go, NodeJS, Rust or others) and forward some other applications over Kubernetes in case you don't want to run them locally.\n\n[\u003cimg src=\"https://github.com/eko/monday/blob/master/misc/schema.jpg?raw=true\" /\u003e](https://youtu.be/6hyCkqHYFQ8)\n\n## What Monday can do for you?\n\n✅  Define a unified way to setup applications for all your developers\n\n✅  Run your local applications\n\n✅  Hot reload your applications automatically when a change is made locally\n\n✅  Port-forward an application locally using a remote one on Kubernetes (targeting a pod via label) or over SSH\n\n✅  Forward traffic of a remote application over Kubernetes, SSH or TCP locally (see example forward types)\n\n✅  Auto reconnect when a port-forward connection is lost\n\n✅  Forward multiple times the same port locally, using an hostname\n\n✅  Monitor your local and/or forwarded applications\n\n## Installation\n\n### Homebrew (macOS)\n\n```bash\n$ brew install eko/homebrew-tap/monday\n```\n\nThis will install the latest available release\n\n### Download binary\n\nYou can download the latest version of the binary built for your architecture here:\n\n* Architecture **i386** [\n    [Linux](https://github.com/eko/monday/releases/latest/download/monday-linux-386)\n]\n* Architecture **amd64** [\n    [Darwin](https://github.com/eko/monday/releases/latest/download/monday-darwin-amd64) /\n    [Linux](https://github.com/eko/monday/releases/latest/download/monday-linux-amd64)\n]\n* Architecture **arm** [\n    [Darwin](https://github.com/eko/monday/releases/latest/download/monday-darwin-arm64) /\n    [Linux](https://github.com/eko/monday/releases/latest/download/monday-linux-arm)\n]\n\n### From sources\n\nOptionally, you can download and build it from the sources. You have to retrieve the project sources by using one of the following way:\n```bash\n$ go get -u github.com/eko/monday\n# or\n$ git clone https://github.com/eko/monday.git\n```\n\nThen, build the binary using the available target in Makefile:\n```bash\n$ make build\n```\n\n## Configuration: Define your projects\n\nConfiguration of Monday lives in one or multiple YAML files, depending on how you want to organize your files.\n\nBy default, `monday init` will initiates a `~/monday.yaml` file. You can customize the configuration directory by setting the `MONDAY_CONFIG_PATH` environment variable.\n\nPlease note that you can also split this configuration in multiple files by respecting the following pattern: `~/monday.\u003csomething\u003e.yaml`, for instance:\n* `~/monday.localapps.yaml`\n* `~/monday.forwards.yaml`\n* `~/monday.projects.yaml`\n\nThis will help you navigate more easily in your configuration files.\n\n### Define a local project\n\nHere is an example of a local application:\n\n```yaml\n\u003c: \u0026graphql-local\n  name: graphql\n  path: $GOPATH/src/github.com/eko/graphql\n  watch: true\n  hostname: graphql.svc.local # Project will be available using this hostname on your machine\n  setup: # Setup, installation step in case specified path does not exists\n    - go get github.com/eko/graphql\n  build: # Optionally, you can define a build section to build your application before running it\n    commands:\n      - go build -o ./build/graphql-app cmd/ # Here, just build the Go application\n    env:\n      CGO_ENABLED: on\n  run:\n    command: ./build/graphql-app # Then, run it using this built binary\n    env: # Optional, in case you want to specify some environment variables for this app\n      HTTP_PORT: 8005\n    env_file: \"github.com/eko/graphql/.env\" # Or via a .env file also\n  files: # Optional, you can also declare some files content with dynamic values coming from your project YAML or simply copy files\n    - type: content\n      to: $GOPATH/src/github.com/eko/graphql/my_file\n      content: |\n        This is my file content and here are the current project applications:\n          {{- range $app := .Applications }}\n          Name: {{ $app.Name }}\n          {{- end }}\n    - type: copy\n      from: $GOPATH/src/github.com/eko/graphql/.env.dist\n      to: $GOPATH/src/github.com/eko/graphql/.env\n```\n\nThen, imagine this GraphQL instance needs to call a user-api but we want to forward it from a Kubernetes environment, we will define it as follows.\n\n### Define a port-forwarded project\n\n```yaml\n\u003c: \u0026user-api-forward\n  name: user-api\n  type: kubernetes\n  values:\n    context: staging # This is your kubernetes cluster (kubectl config context name)\n    namespace: backend\n    labels:\n      app: user-api\n    hostname: user-api.svc.local # API will be available under this hostname\n    ports:\n     - 8080:8080\n```\n\nWell, you have defined both a local app and an application that needs to be forwarded, now just create the project!\n\n### Define a project with both local app and a port-forwarded one\n\n```yaml\n - name: graphql\n   local:\n    - *graphql-local\n   forward:\n    - *user-api-forward\n```\n\nYour project configuration is ready, you can now work easily with your microservices.\n\nFor an overview of what's possible to do with configuration file, please look at the [configuration example directory here](https://github.com/eko/monday/tree/master/example).\n\nTo learn more about the configuration, please take a look at the [Configuration Wiki page](https://github.com/eko/monday/wiki/Configuration).\n\n## Usage: Run your projects!\n[![Monday Asciinema](https://asciinema.org/a/aB9ZkCmJS6m1b4uv8Dio1i59U.svg)](https://asciinema.org/a/aB9ZkCmJS6m1b4uv8Dio1i59U)\n\nFirst, you have to initialize monday and edit your configuration file (you have a [configuration example directory here](https://github.com/eko/monday/tree/master/example)).\nRun the following command and edit the `~/monday.yaml` configuration file just created for you:\n\n⚠️ *Important note*: Because Monday tries to be your best dev tool and manage things for you, you have to give it some chances to help you in editing host file and manipulating network interface for IP/port mapping.\n\nThat's why I suggest to run Monday using the following alias:\n\n```bash\nalias monday='sudo -E monday'\n```\n\n```bash\n$ monday init\n```\n\nOnce your configuration file is ready, you can simply run Monday:\n\n```bash\n$ monday [--ui]\n```\n\nNote the `--ui` option that will allow you to enable the user interface (you can also define a `MONDAY_ENABLE_UI` environment variable to enable it).\n\nOr, you can run a specific project directly by running:\n\n```bash\n$ monday run [--ui] \u003cproject name\u003e\n```\n\nWhen you want to edit your configuration again, simply run this command to open it in your favorite editor:\n\n```bash\n$ monday edit\n```\n\n\n## Environment variables\n\nThe following environment variables can be used to tweak your Monday configuration:\n\n\n| Environment variable         | Description                                                                               |\n|:----------------------------:|-------------------------------------------------------------------------------------------|\n| MONDAY_CONFIG_PATH           | Specify the configuration path where your YAML files can be found                         |\n| MONDAY_EDITOR                | Specify which editor you want to use in order to edit configuration files                 |\n| MONDAY_EDITOR_ARGS           | Specify the editor arguments you want to pass (separated by coma), example: -t,--wite     |\n| MONDAY_ENABLE_UI             | Specify that you want to use the terminal UI instead of simply logging to stdout          |\n| MONDAY_KUBE_CONFIG           | Specify the location of your Kubernetes config file  (if not in your home directory)      |\n\n## Community\n\nYou can [join the community Slack space](https://join.slack.com/t/mondaytool/shared_invite/enQtNzE3NDAxNzIxNTQyLTBmNGU5YzAwNjRjY2IxY2MwZmM5Njg5N2EwY2NjYzEwZWExNWYyYTlmMzg5ZTBjNDRiOTUwYzM3ZDBhZTllOGM) to discuss about your issues, new features or anything else regarding Monday.\n\n## Run tests\n\nTest suite can be run with:\n\n```bash\n$ go test -v ./...\n```\n","funding_links":["https://github.com/sponsors/eko"],"categories":["Continuous Delivery \u0026 GitOps","Go","\u003ca name=\"Go\"\u003e\u003c/a\u003eGo"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feko%2Fmonday","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feko%2Fmonday","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feko%2Fmonday/lists"}