bitrise-workflow-editor

(โ˜… 115)

Bitrise Workflow Editor

  • .editorconfig
  • .gitignore
  • .lintstagedrc.json
  • .mcp.json
  • .tool-versions
  • bitrise-plugin.yml
  • bitrise.yml
  • CLAUDE.md
  • eslint.config.mjs
  • go.mod
  • go.sum
  • gows.yml
  • jest.config.cjs
  • knip.json
  • LICENSE
  • main.go
  • package-lock.json
  • package.json
  • playwright.config.ts
  • README.md
  • release_config.yml
  • renovate.json
  • tsconfig.json
  • vite-env.d.ts
  • vite.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/bitrise-io/bitrise-workflow-editor

Downloads the entire project code from GitHub to your computer.

cd bitrise-workflow-editor

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • 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.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f deployments/local/Dockerfile -t bitrise-workflow-editor .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 bitrise-workflow-editor

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm start # start both local plugin api and webpack dev server

Starts the development/run server.

npm run start:website # starts WFE in website mode

Starts the development/run server.

PUBLIC_URL_ROOT=http://localhost:4000 npm run start:website

Starts the development/run server.

npm test # run unit tests on already compiled client

Type this command into your terminal and run it.

npm run e2e:api # run only the local binary api for e2e tests

Type this command into your terminal and run it.

โœ… 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

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go install

Type this command into your terminal and run it.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation