builder

(โ˜… 2,306)

Craft beautiful websites effortlessly with an intuitive visual builder and publish them instantly

  • .git-blame-ignore-revs
  • .gitignore
  • .gitmodules
  • .pre-commit-config.yaml
  • .releaserc
  • AGENTS.md
  • babel_extractors.csv
  • CLAUDE.md
  • commitlint.config.js
  • crowdin.yml
  • frappe-ui
  • LICENSE
  • package.json
  • pyproject.toml
  • README.md
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/frappe/builder

Downloads the entire project code from GitHub to your computer.

cd builder

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.
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/builder/develop/docker/docker-compose.yml

Runs the command against the services defined in the compose file.

wget -O init.sh https://raw.githubusercontent.com/frappe/builder/develop/docker/init.sh

Type this command into your terminal and run it.

docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

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

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.
yarn dev-setup

Starts the development/run server.

yarn dev --host

Starts the development/run server.

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

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation