{"id":26579826,"url":"https://github.com/mondaycom/apps-sdk-local-server","last_synced_at":"2026-04-10T23:57:09.214Z","repository":{"id":254120612,"uuid":"768060399","full_name":"mondaycom/apps-sdk-local-server","owner":"mondaycom","description":"A local server for the apps-sdk package","archived":false,"fork":false,"pushed_at":"2025-03-17T09:20:15.000Z","size":209,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T10:32:21.964Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/mondaycom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2024-03-06T11:54:17.000Z","updated_at":"2024-12-16T07:57:16.000Z","dependencies_parsed_at":"2024-08-21T14:56:38.123Z","dependency_job_id":"c207be77-82de-4f4a-aa06-5e2307de6d61","html_url":"https://github.com/mondaycom/apps-sdk-local-server","commit_stats":null,"previous_names":["mondaycom/apps-sdk-local-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondaycom%2Fapps-sdk-local-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondaycom%2Fapps-sdk-local-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondaycom%2Fapps-sdk-local-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondaycom%2Fapps-sdk-local-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mondaycom","download_url":"https://codeload.github.com/mondaycom/apps-sdk-local-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245066066,"owners_count":20555392,"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":[],"created_at":"2025-03-23T06:29:10.217Z","updated_at":"2026-04-10T23:57:04.145Z","avatar_url":"https://github.com/mondaycom.png","language":"TypeScript","readme":"# Apps SDK Local Server\n\nThis project provides a local server environment for developing and testing applications with the monday code SDK. It emulates the behavior of the SDK in a production environment, offering identical capabilities and API endpoints, allowing seamless transitions between your local setup and the production SDK.\n\n## Getting Started\n\nFollow the steps below to get a local copy of this project up and running on your machine for development and testing.\n\n### Prerequisites\n\n- **Docker**: Ensure Docker is installed on your machine. You can download it from [here](https://www.docker.com/get-started).\n\n### Running the Application\n\n1. **Configure the Docker Volume:**\n\n   - Open the `docker-compose.yml` file.\n   - Replace `\u003cVOLUME_FOR_LOCAL_SERVER_IN_LOCAL_MACHINE\u003e` with the path to your local machine's desired volume.\n   - Set the `VOLUME_PATH` environment variable in the same file to match the volume path.\n\n2. **Start the Docker Container:**\n\n   Run the following command in your terminal:\n\n   ```bash\n   docker compose up\n   ```\n\n3. **Access the Application:**\n\n   Once the container is up and running, your application will be accessible at `http://localhost:59999`.\n\n## Capabilities Requiring Configuration\n\n### Queue Management\n\nThis server includes a queue management system for handling time-consuming tasks efficiently in the background, improving both performance and reliability. The queue processes tasks in the order they are received and retries in case of failures, ensuring no task is lost.\n\nTo configure the queue capability:\n\n- **`PUB_SUB_DEV_APP_SERVICE_URL`**: URL of the local server that handles task execution.\n- **`PUB_SUB_RETRY_INTERVAL_IN_SECONDS`**: Time interval (in seconds) for retrying failed requests.\n\nThese environment variables are set within the `docker-compose.yml` file.\n\n## Development Routes\n\nThe local server provides additional routes to facilitate development:\n\n1. **Set Environment Variable**:\n\n   - **Endpoint:** `/test/environments/{name}`\n   - **Method:** `PUT`\n   - **Description:** Sets the environment variable `{name}` to the value provided in the request body.\n\n2. **Set Secret**:\n   - **Endpoint:** `/test/secrets/{name}`\n   - **Method:** `PUT`\n   - **Description:** Sets the secret `{name}` to the value provided in the request body.\n\n## License\n\nThis project is licensed under the MIT License. For more details, see the `LICENSE.md` file.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmondaycom%2Fapps-sdk-local-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmondaycom%2Fapps-sdk-local-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmondaycom%2Fapps-sdk-local-server/lists"}