Skip to content

frappe/builder

Repository files navigation

Frappe Builder Logo

Frappe Builder

Crafting Web Pages Made Effortless!

Frappe Builder Web page design credit

Frappe Builder

Frappe Builder is a low-code website builder designed for simplicity, speed, and flexibility. Craft beautiful websites effortlessly with an intuitive visual builder. Whether you're a designer looking for ease or a developer seeking customization, Frappe Builder empowers you. It also features a click-to-publish option that gives you the complete end-to-end website creation experience.

Key Features

  • Intuitive Visual Builder: Simplify your workflow with a Figma-like editor.
  • Responsive Views: Ensure your sites look great on any device without the fuss.
  • Frappe CMS Integration: Easily fetch data from your database and create dynamic pages.
  • Scripting Capabilities: Customize with client scripts, global scripts, and styles.
  • Efficient Workflow: Use subtle shortcuts like image dropping and streamlined page copying and more to efficiently develop pages.
  • One-Click Publishing: Instantly share your creations with the world in a single click.
  • Performance Excellence: Frappe Builder does not bloat web pages with unnecessary scripts hence pages built with Frappe Builder are highly performant, consistently scoring high on Google Lighthouse tests.

Getting Started

Managed Hosting

Get started with your personal or business site with a few clicks on Frappe Cloud.

Docker (Recommended)

The quickest way to set up Frappe Builder and take it for a test ride.

Frappe framework is multi-tenant and supports multiple apps by default. This docker compose is just a standalone version with Frappe Builder pre-installed. Just put it behind your desired reverse-proxy if needed, and you're good to go.

If you wish to use multiple Frappe apps or need multi-tenancy. Take a look at our production ready self-hosted workflow, or join us on Frappe Cloud to get first party support and hassle-free hosting.

Step 1: Setup folder and download the required files

mkdir frappe-builder
cd frappe-builder

Step 2: Download the required files

Docker Compose File:

wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/builder/develop/docker/docker-compose.yml

Frappe Builder bench setup script

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

Step 3: Run the container and daemonize it

docker compose up -d

Step 4: The site http:https://builder.localhost should now be available. The default credentials are:

username: administrator
password: admin

Self-hosting

If you prefer self-hosting, follow the official Frappe Bench Installation instructions.

Want to just try out or contribute?

Codespaces

builder-getting-started.mp4
  1. Open this link and click on "Create Codespace".
  2. Wait for initialization (~15 mins).
  3. Run bench start from the terminal tab.
  4. Click on the link beside "8000" port under "Ports" tab.
  5. Log in with "Administrator" as the username and "admin" as the password.
  6. Go to <random-id>.github.dev/builder to access the builder interface.

Local Setup

  1. Install Bench.
  2. Install Frappe Builder app:
    $ bench get-app builder
  3. Create a site with the builder app:
    $ bench --site sitename.localhost install-app builder
  4. Open the site in the browser:
    $ bench browse sitename.localhost --user Administrator
  5. Access the builder page at sitename.localhost:8000/builder in your web browser.

Need help?

Join our telegram group for instant help.

License

GNU Affero General Public License v3.0