Get started with Backrush

Backrush is a backend platform for developing Web, Mobile, and Flutter applications. Built with the open source community and optimized for developer experience in the coding languages you love.

Backrush is an end-to-end backend server for Web, Mobile, Native, or Backend apps packaged as a set of Docker microservices. Backrush abstracts the complexity and repetitiveness required to build a modern backend API from scratch and allows you to build secure apps faster.

Using Backrush, you can easily integrate your app with user authentication and multiple sign-in methods, a database for storing and querying users and team data, storage and file management, image manipulation, Cloud Functions, messaging, and more services.

Find out more at: https://backrush.io.

Table of Contents:

• Getting Started
• Self-Hosting
  • Unix
  • Windows
    • CMD
    • PowerShell
  • Upgrade from an Older Version
• One-Click Setups
• Architecture
• Contributing
• Security
• Follow Us
• License

Getting Started

The easiest way to get started with Backrush is by signing up for Backrush. While Backrush Cloud is in public beta, you can build with Backrush completely free, and we won't collect you credit card information.

Self-Hosting

Backrush is designed to run in a containerized environment. Running your server is as easy as running one command from your terminal. You can either run Backrush on your localhost using docker-compose or on any other container orchestration tool, such as Kubernetes, Docker Swarm, or Rancher.

Before running the installation command, make sure you have Docker installed on your machine:

Unix

docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/backrush:/usr/src/code/backrush:rw \
    --entrypoint="install" \
    backrush/backrush:1.7.3

Windows

CMD

docker run -it --rm ^
    --volume //var/run/docker.sock:/var/run/docker.sock ^
    --volume "%cd%"/backrush:/usr/src/code/backrush:rw ^
    --entrypoint="install" ^
    backrush/backrush:1.7.3

PowerShell

docker run -it --rm `
    --volume /var/run/docker.sock:/var/run/docker.sock `
    --volume ${pwd}/backrush:/usr/src/code/backrush:rw `
    --entrypoint="install" `
    backrush/backrush:1.7.3

Once the Docker installation is complete, go to http://localhost to access the Backrush console from your browser. Please note that on non-Linux native hosts, the server might take a few minutes to start after completing the installation.

For advanced production and custom installation, check out our Docker environment variables docs.

Upgrade from an Older Version

If you are upgrading your Backrush server from an older version, you should use the Backrush migration tool once your setup is completed. For more information regarding this, check out the Installation Docs.

One-Click Setups

In addition to running Backrush locally, you can also launch Backrush using a pre-configured setup. This allows you to get up and running quickly with Backrush without installing Docker on your local machine.

Choose from one of the providers below:

DigitalOcean

Gitpod

Akamai Compute

AWS Marketplace

Products

For the complete API documentation, visit https://backrush.io/docs.

Architecture

Appwrite uses a microservices architecture that was designed for easy scaling and delegation of responsibilities. In addition, Appwrite supports multiple APIs, such as REST, WebSocket, and GraphQL to allow you to interact with your resources by leveraging your existing knowledge and protocols of choice.

The Appwrite API layer was designed to be extremely fast by leveraging in-memory caching and delegating any heavy-lifting tasks to the Appwrite background workers. The background workers also allow you to precisely control your compute capacity and costs using a message queue to handle the load. You can learn more about our architecture in the contribution guide.

Contributing

All code contributions, including those of people having commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Security

For security issues, kindly email us at hello@backrush.io instead of posting a public issue on GitHub.

Follow Us

Join our growing community around the world! Check out our official Blog. Follow us on X

License

This repository is available under the BSD 3-Clause License.