skip to main content

Getting started

This guide is for first-time Livebase users and shows all the necessary steps to configure and deploy a working cloudlet.

1. Install the Dashboard #

Access this page: https://www.livebase.com/download-the-livebase-dashboard.

Click on the download link corresponding to your operating system and follow the installation procedure:

Install the Dashboard on Linux Tar

2. Open the Dashboard #

Dashboard desktop icon Run the Dashboard by clicking on the icon shown on the left.

Log in using the credentials you were provided with in the Livebase account creation confirmation email.

Dashboard login

Once logged in, the Dashboard appears as in the figure, divided into the following tabs:

  • Engine models: a collection of archived engine models that can be extended and reused at any time;
  • Cloudlets: a list of all cloudlets created in your account.

Screenshot dashboard

3. Create a cloudlet #

Click on the + New cloudlet button at the bottom right of the Cloudlets tab.

The name of the cloudlet and its URL address are displayed at the top. By default Livebase assigns the name NewCloudlet1. Each of the cloudlets created under your account must have a unique name.

There are three icons in the center of the cloudlet:

Community the list of members of the cloudlet;

Missing engine the engine (currently absent);

Missing database the database (currently absent);

Renaming the cloudlet

4. Download the sample engine models #

Download this package Sample-engine-models.zip and choose one of the engine models within it.

Each sample engine model folder contains two files:

  • a .xml file (the engine model)
  • a .sql file (the corresponding database)

5. Install an engine #

Missing engine Drag the .xml file onto the cloudlet. Alternatively, click on the icon in the bottom right of the panel and select the Upload engine option from the dropdown menu.

Engine Now the engine icon becomes orange, as shown in the image on the left.

Creating a new engine model

6. Install a database #

Database Drag the .sql file from the sample engine folder into the cloudlet.
Alternatively, click on the icon at the bottom right of the panel and select Upload Excel from the drop-down menu.

7. Create a member #

Community Click on the icon on the left to open the Members of the cloudlet panel and then click on the Create Member button.

Members of the cloudlet

Fill the form with your credentials, select one of the available applications from the dropdown menu and check the Admin box, as show in the figure on the right.

Create new member

8. Start the cloudlet #

Click on the Start button on the cloudlet.
Please wait a few moments while the cloudlet is being built and deployed.

Start cloudlet

9. Access the GraphiQL client #

Now the cloudlet is operational and can be accessed through the related endpoint(s). Click on the cloudlet header to open the GraphiQL client.

Open GraphiQL

10. Next steps #

To learn more about modeling with the Designer, plugin integration and the GraphQL API, see the Guides section available at the following link.

Feel free to reach out to us if you have any questions: support@livebase.com