{"id":15732083,"url":"https://github.com/squishy123/branch-deploy","last_synced_at":"2026-02-06T04:30:57.533Z","repository":{"id":44141302,"uuid":"188465864","full_name":"Squishy123/branch-deploy","owner":"Squishy123","description":"Manage the deployment of multiple branches through an API ","archived":false,"fork":false,"pushed_at":"2023-01-03T22:35:54.000Z","size":417,"stargazers_count":0,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-31T03:24:42.810Z","etag":null,"topics":["api","branch","deployment","devops","git"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Squishy123.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}},"created_at":"2019-05-24T17:56:04.000Z","updated_at":"2019-06-02T20:10:12.000Z","dependencies_parsed_at":"2023-02-01T11:46:12.127Z","dependency_job_id":null,"html_url":"https://github.com/Squishy123/branch-deploy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Squishy123/branch-deploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Squishy123%2Fbranch-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Squishy123%2Fbranch-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Squishy123%2Fbranch-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Squishy123%2Fbranch-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Squishy123","download_url":"https://codeload.github.com/Squishy123/branch-deploy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Squishy123%2Fbranch-deploy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265434998,"owners_count":23764634,"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":["api","branch","deployment","devops","git"],"created_at":"2024-10-04T00:08:14.681Z","updated_at":"2026-02-06T04:30:57.527Z","avatar_url":"https://github.com/Squishy123.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# branch-deploy\n### Manage the deployment of multiple branches through an API \n\n## What is this used for?\n### When you want to quickly deploy test branches of NodeJS server-side applications onto temporary hosts. Back-end API's, front-end previews - anything with a host server. \n\n## How does this work?\n### Essentially, this project acts as a master controller, managing the different branches of a git repo. When the branch-deploy API is triggered, the controller clones the repo locally, checkouts the specified branch and then starts it up on a unique hostname. \n\n## Application ENV variables \n### When you build your application, it needs to have a few ENV variables working in order to properly assign a unique route prefix. Branch-deploy expects a dotenv configuration type setup: .env is stored in the project root and is automatically binded to the application on runtime. Your rout\n\n| Variable | Description                                |\n|----------|--------------------------------------------|\n| PREFIX   | Assigns a host for the server to listen on |\n| HOST     | Assigns a host for the server to listen on |\n| PORT     | Assigns a port for the server to listen on |\n\n## Branch-Deploy ENV variables \n### Before you can use branch-deploy you will have to setup a few ENV variables. \n\n| Variable  | Description                                              |\n|-----------|----------------------------------------------------------|\n| REPO_URL  | The URL of the git repo you want to deploy               |\n| GIT_USER  | Your git username                                        |\n| GIT_PASS  | Your git password                                        |\n| APP_ENTRY | Location of your entry file relative to root of app repo |\n| HOST      | Assign a host for branch-deploy to listen on(optional)   |\n| PORT      | Assign a port for branch-deploy to listen on(optional)   |\n\n### NOTE: Any additional variables defined in your application can be added to the .additional.env in the branch-deploy. These will be automatically binded to the application environment. \n\n## Quick-Start\n### 1. Start off by cloning this [repo](https://github.com/Squishy123/branch-deploy.git). \n### 2. Copy .example.env to .env and fill in your branch-deploy ENV variables.\n### 3. Install project dependencies: \n### ` yarn ` or ` npm install `\n### 4. Start up the branch-deploy server:\n### `yarn start` or `npm run start`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquishy123%2Fbranch-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsquishy123%2Fbranch-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquishy123%2Fbranch-deploy/lists"}