Baserow consists of two main components:
The backend consists of the core, api and database apps. The package also contains base settings that can be extended. The REST API is written as a decoupled component which is not necessary to run Baserow. It is highly recommended though. The same goes for the database app, this is written als a plugin for Baserow. Without it you would only have the core which only has functionality like authentication, groups and the application abstraction.
If you look at the code of the API views you will notice that they use classes like CoreHandler, TableHandler, FieldHandler etc. The API views are actually a REST API shell around these handlers which are doing the actual job. The reason why we choose to do it this way is that if we ever want to implement a Web Socket API, SOAP API or any other API we can also build that around the same handler. That way we never have to write code twice. It is also useful for when you want to do something via the command line. If you for example want to create a new group you can do the following.
from django.contrib.auth import get_user_model from baserow.core.handler import CoreHandler User = get_user_model() user = User.objects.get(pk=1) group = CoreHandler().create_group(user, name='Example group')
The web-frontend consists of the core and database modules. The package also contains some base config that can be extended. It is basically a user friendly shell around the backend that can run in your browser. It is made using NuxtJS.
A group can contain multiple applications. It can be used to define a company and in the
future it is going to be possible to invite extra users to a group. Every user in the
group has access to all the applications within that group. Unfortunately it is not yet
possible to add extra users because the live collaboration feature has to be
implemented first. Groups can easily be created, edited and deleted via the
baserow.core.handler.CoreHandler and via the REST API.
An application is more of an abstraction that can be added to a group. By default the
database plugin is included which contains the database application. Via the
“create new” button in the sidebar a new application instance can be created for the
selected group. Once you click on it you will see a context menu with all the
application types. Plugins can introduce new application types. Applications can easily
be created, edited and deleted via the
baserow.core.handler.CoreHandler and via the
More information about the concepts of the database application can be found on the database plugin introduction page.
In combination with the default settings and config the following environment variables are accepted.
baserow): The database name of PostgreSQL database.
baserow): The username for the PostgreSQL database.
baserow): The password for the PostgreSQL database.
db): The hostname of the PostgreSQL server.
5432): The port of the PostgreSQL server.
mjml): The hostname of the MJML TCP server. In the development environment we use the
28101): The port of the MJML TCP server.
localhost:8000): The publicly accessible domain name of the backend. For the development environment this is localhost:8000, but if you for example change the port to 9000 this should be
http://localhost:8000): The publicly accessible URL of the backend. For the development environment this is
http://localhost:8000, but if you for example change the port to 9000 this should be
http://localhost:9000. You should be able to lookup this url with your browser.
http://backend:8000): Not only the browser, but also web-frontend server should be able to do HTTP requests to the backend. It might not have access to the
PUBLIC_BACKEND_URLor there could be a more direct route, (e.g. from container to container instead of via the internet). In case of the development environment the backend container be accessed via the
backendhostname and because the server is also running on port 8000 inside the container, the private backend URL should be
localhost:3000): The publicly accessible domain name of the web-frontend. For the development environment this is localhost:3000, but if you for example change the port to 4000 this should be
http://localhost:3000): The publicly accessible URL of the web-frontend. For the development environment this is
http://localhost:3000, but if you for example change the port to 4000 this should be
http://localhost:4000. You should be able to lookup this url with your browser.
no-reply@localhost): If the from email address of the emails that the platform sends. For example when the user requests a password change because he has forgotten it.