Skip to content

Latest commit

 

History

History
128 lines (81 loc) · 3.81 KB

README.md

File metadata and controls

128 lines (81 loc) · 3.81 KB
Raw

Outerbridge - Automate Web3 and Web2 applications

Outerbridge is a low code/no code workflow automation application, focusing on integrating both on-chain and off-chain applications. The project is licensed under Apache License Version 2.0, source available and free to self-host.

Outerbridge

Outerbridge Screenshot

💡Why another workflow automation tool?

There are many awesome automation tools out there, however there isn't one that has the built-in logic of interacting/consuming information from blockchains. Hence, Outerbridge is created to allow people building workflows involving on-chain and off-chain applications, with simple drag and drop interface.

⚡Quick Start

Watch Outerbridge Quickstart Demo on Youtube (4mins)

  1. Install MongoDB locally OR follow the guide of using MongoDB Atlas here

  2. Install Outerbridge

    npm install -g outerbridge

  3. Start Outerbridge

    npx outerbridge start

    If using MongoDB Atlas

    npx outerbridge start --mongourl=mongodb+srv://<user>:<password>@<your-cluster>.mongodb.net/outerbridge?retryWrites=true&w=majority

  4. Open http://localhost:3000

🐳 Docker

  1. Go to docker folder at the root of the project
  2. docker-compose up -d
  3. This will automatically spins up mongodb and outerbridge containers
  4. Open http://localhost:3000
  5. You can bring the containers down by docker-compose stop
  6. If using MongoDB Atlas, follow the guide here

👨‍💻 Developers

Outerbridge has 3 different modules in a single mono repository.

  • server: Node backend to serve API logics
  • ui: React frontend
  • components: Nodes and Credentials of applications

Prerequisite

  • Install MongoDB locally OR register a MongoDB Atlas here
  • Install Yarn 
    npm i -g yarn

Setup

  1. Clone the repository

    git clone https://github.com/Outerbridgeio/Outerbridge.git

  2. Go into repository folder

    cd Outerbridge

  3. Install all dependencies of all modules:

    yarn install

  4. Build all the code:

    yarn build

  5. Start the app:

    yarn start

    You can now access the app on http://localhost:3000

  6. For development build:

    yarn dev

    Any code changes will reload the app automatically on http://localhost:8080

📖 Documentation

Official Outerbridge docs can be found under: https://docs.outerbridge.io

💻 Cloud Hosted

🌐 Self Host

🙋 Support

Feel free to ask any questions, raise problems, and request new features in discussion

🙌 Contributing

See contributing guide. Reach out to us at Discord if you have any questions or issues.

📄 License

Source code in this repository is made available under the Apache License Version 2.0.