Overview:

CAB is a boilerplate that allows users to easily create websites with multiple computational apps. It is designed for scientists and programmers who want to quickly put an algorithm online behind a user interface. CAB provides a complete integrated system with features such as a HTTP proxy, job queues, and presets for development and production. It requires familiarity with Python and Vue.js.

Features:

• Versatile and fun technologies: CAB uses Python and Django in the backend to run scientific and computational routines, and Vue.js in the frontend, one of the easiest frameworks to learn and maintain.
• Docker-compose deployment: Deploy your app anywhere with just a few lines using Docker-compose.
• Simple app creation: Adding a new app is easy - just add one file in the frontend for the input form and one file in the backend for the code of computations.
• Full live-reload: Changes made to the backend or frontend code take effect immediately without the need to refresh a page or restart a server manually.
• Easy-to-use library of components: Build your user interface effortlessly using Element, a library of components.
• Works on any machine: One-line installation and deployment with no clashes with the rest of your system since everything runs inside containers.

Installation:

To get started with the CAB app, you will need to have familiarity with Python, Vue, Docker, and Git. Follow the steps below to download, install, and launch CAB on your computer:

1. Install Docker and Docker-compose on your machine. Instructions may vary depending on your operating system (Windows, Linux, MacOS), so you may need to refer to the appropriate documentation.
2. Download CAB from GitHub.
3. Navigate to the root CAB directory, which contains the README and docker-compose.yml files.
4. Launch the application using the provided command. Docker will download and build the necessary components, which may take a few minutes for the first time but only a few seconds in subsequent runs.
5. Open your web browser and type “localhost” or “127.0.0.1” in the address bar. The website should appear, and the console where you launched docker-compose will display logs for the different components (django, vue) for debugging purposes.

Summary:

CAB is a boilerplate that simplifies the process of creating websites with multiple computational apps. It is designed for scientists and programmers and offers features such as Docker-compose deployment, live-reload for immediate code changes, and an easy-to-use component library. Installation requires familiarity with Python, Vue, Docker, and Git. Overall, CAB provides a convenient and efficient solution for putting algorithms online behind user interfaces.