Getting started

This section will describe the steps for you to build your first app and deploy it to Carol.

Introduction

This section describes how to create Carol App using the template available on Carol. Currently, you are able to create three types of Carol Apps:

  • Online Carol App: This type of Carol App allows us to provide services on top of Carol. Basically, we will develop endpoints and the deploy will happen on top of Carol. The template provided today is using Flask and python as an example, but you can deploy any technology (on our repository you can see an example using NodeJS) that you can be embedded in a docker image.

  • Batch Carol App: This type of Carol App allows us to build applications and schedule the recurrence to run it. The template provided today is using python, but you can write your code in any technology embedded in a docker image.

  • Web Carol App: This type of Carol App allows you to deploy any HTML content. By default, our example uses the framework PO (https://po-ui.io/) as the base, but you can deploy any HTML content to Carol.

The following sections will explain details about how to create these Carol App through the wizard provided by Carol.

First step to create a Carol App

This section will demonstrate to you how to start the wizard to create one of the three possible Carol Apps, as already described in the previous section.

Please, execute the following command:

bash -c "$(curl -fsSL https://raw.github.com/totvslabs/carolapp/master/install.sh)"

As a result, the following result is shown to the user:

____                _    _
  / ___|__ _ _ __ ___ | |  / \   _ __  _ __
 | |   / _` | '__/ _ \| | / _ \ | '_ \| '_ \
 | |__| (_| | | | (_) | |/ ___ \| |_) | |_) |
  \____\__,_|_|  \___/|_/_/   \_\ .__/| .__/
                                |_|   |_|

This script will help you create your new Carol App.
Just select which type of Carol App you want to create and answer the questions the script will ask about your new app.

? Which Carol App do you want to create? (Use arrow keys)
❯ Online App
  Batch App
  Web App

The main goal for the user is to choose the type of Carol App he wants, following the explanation on the Introduction chapter.

Depending on the user's selection, the process will guide the user to create one of the three available Carol Apps. You need to use the arrows to change your selection.

Depending on the Carol App type, you need to follow specific documentation:

Sample Repositories

We are maintaining a repository with some Carol App as a sample. The structure follows exactly the same as presented in this documentation.

https://github.com/totvslabs/carolapp-samples