🚦General guide & concepts

The following key components and concepts are essential to using the platform.


IncludeCore dashboard

Your dashboard will show all projects you can access, and the label will inform you if you are the project owner or if your access is constrained to a developer (dev) or editor role. The dashboard also contains developer templates to get started in minutes.

The IncludeCore dashboard also displays your account's current API usage and license status, which are calculated across all your projects.


Developer console

The console empowers developers to initiate and oversee projects, generate and oversee various API types via our user-friendly builder tool, and access and administer API endpoints.

Furthermore, developers can review plan utilisation and performance metrics on the console dashboard. Usage data is consolidated at the account level, enabling you to utilise allocations across all projects. Depending on the licensing plan, owners can also include and add and remove other users, such as developers with console access and users with access limited to the editor panels.


Switching between the dev and editor panel

Project owners and developers can easily switch between developer and editor views via the toggle at the top of the left-hand navigation rail.

Users who have editor-only permission for a project will only see an editor label and are not able to access the models.


Editor panel

The editor panel is automatically generated alongside each project created in the console. Each panel has its unique URL. If users have access to multiple projects, they can switch between projects within the top navigation of both the console and the editor panel.

Content and data editors are restricted to adding and managing content solely within their respective panels; they do not have permission to modify any project-related configurations set in the console.


Projects

A project can represent a website, an app, or an IoT application, and it can accommodate various types of APIs. Additionally, each project creates its own dedicated editor panel. You have the option to invite contributors to collaborate on the project.


Project templates

Everything on project templates is here.


Databases

A database serves as a repository of records and can be linked to an optional CRUD (Create, Read, Update, Delete) API. It's the ideal location for storing various data, including blog posts, contact form responses, and more.


Static screens

Static screens represent the static elements or sections of a web page or application screen, making them easily editable through our editor panels.


Global items

Global items represent static elements that appear on all or most screens, such as a logo. Global items will automatically publish attached to all static screen APIs.

Last updated