Skip to content

Getting Started

Welcome to the Getting Started guide!

Overview

This guide outlines the process of using the codbex platform to create your initial 'Hello World' service. For more in-depth technical information on various aspects of the platform, its components, and capabilities, refer to the documentation listed in the references section below.

Hello World

In this guide, we'll walk you through creating a simple "Hello World" service using the Request and Response APIs.

Setting Up Your Environment

Before we begin, ensure you have the necessary tools installed and your development environment configured.

You can run the all in one platform as a Docker container as described here or build and run locally.

Access the instance

In case of a local setup on your machine, you can access the web IDE at the following location: http://localhost/

Default Credentials

The default username is admin and the default password is admin. The credentials can be updated, as described in the configuration options.

Creating Your First Service

Let's start by creating a basic "Hello World" service. We'll use the Request API to get the REST method from the incoming requests and the Response API to send a response back to the client.

Create a Hello World service

Once you have a running codbex instance, you can start with your project:

  1. Right-click inside the Projects view.

  2. From the menu select the New Project option.

    New Project

  3. Enter hello-world for the name of the project and click the Create button.

    Create Project

  4. Right-click on the hello-world project in the Projects view and choose JavaScript service from the New dropdown:

  5. Select the New → JavaScript Service option:

    Create JavaScript Service

  6. Enter hello-service.mjs for the name of the JavaScript Service:

    Create JavaScript Service

  7. Double-click on the hello-service.js to open the file in the editor on the right.

    Service Impletentation

Info

The file already contains a Hello World service implementation. As it's not specified otherwise, the service can be executed by performing any of the following HTTP methods: GET, POST, PUT, DELETE and PATCH.

  • Click on the Publish All button from the toolbar:

    Publish Project

  • With the service.js selected in the Projects view, check the result of the execution of the server-side JavaScript Service in the Preview view:

    Preview Project

Note

The JavaScript Service is published and available at the http://localhost/services/js/hello-world/hello-service.mjsURL. It can be accessed in a separate browser tab, consumed by a third-party application or API tools like Postman or cURL.

Explore the Tooling

Overview: Getting Started with Tooling

This overview will guide you through the basics of the various tools and perspectives available within the platform's workbench. Whether you're managing databases, debugging applications, or designing integration flows, this comprehensive set of tools empowers you to streamline your development workflow and maximize productivity.

Workbench Basics

  • Workbench: The central hub where you perform your development tasks. It provides access to various perspectives and tools tailored to different aspects of application development.

  • Import Area: Easily import existing projects or resources into your workspace.

  • Search Area: Quickly find files, resources, or symbols within your project.

  • Properties Area: View and edit properties of selected files or resources.

  • Console View: Monitor application logs and execute commands directly within the platform.

  • Code Editor (Monaco): Write, edit, and debug code using the powerful Monaco editor, which provides syntax highlighting, auto-completion, and other advanced features.

  • Problems View: Identify and resolve issues in your codebase with real-time error and warning notifications.

  • Preview View: Preview web pages, documents, or other content directly within the platform.

  • Logs View: Monitor system logs and diagnostic information to troubleshoot issues.

  • Loggers View: Configure logging settings for different components within your application.

Git Perspective

  • Git Projects View: Manage Git repositories, clone, pull, push, and share projects seamlessly.

  • Local Branches View: View and manage local branches within your Git repository.

  • Remote Branches View: Explore and interact with remote branches in your Git repository.

  • History View: Track changes and revisions in your Git repository's history.

  • Git Staging View: Stage, unstage, and commit changes to your Git repository.

  • Diff Editor: Compare and merge differences between files or commits.

Databases Perspective

  • Database Explorer: Interact with databases, execute queries, and manage database connections.

  • NoSQL Datasources Support: Seamlessly work with NoSQL databases and data sources.

  • SQL Console: Execute SQL queries and commands directly within the platform.

  • Result View: View query results and data sets returned from database operations.

  • Databases View: Manage database connections, configurations, and schemas.

  • Transfer View: Transfer data between different databases and data sources seamlessly.

  • Data Export and Import: Export and import data between databases using CSV and JSON formats.

Debugger Perspective

  • Debugger Basics: Debug applications using a suite of tools including breakpoints, call stack, variables, and watch expressions.

  • Debugging Tools: Utilize debugging tools to identify and fix issues in your codebase.

  • Breakpoints View: Set breakpoints to pause execution at specific points in your code.

  • Call Stack View: View the call stack to understand the flow of execution.

  • Variables View: Inspect and modify variable values during debugging sessions.

Documents Perspective

Processes Workspace Perspective

Terminal Perspective

  • Terminal Basics: Access a command-line interface directly within the platform.

  • Commands and Shortcuts: Execute commands, navigate directories, and perform various tasks using terminal commands.

Modelling Applications

Overview: Getting Started with MDD

This overview will guide you through the basics of the model driven techniques.

Model-Driven Development (MDD)

The codbex platform offers a comprehensive set of MDD features, including entity data modeling, code generation, predefined modules, and application building blocks. By leveraging these features, organizations can streamline the development process, reduce development time and costs, and deliver high-quality applications that meet their business requirements.

  • General Overview: Understand the concept and benefits of Model-Driven Architecture (MDA) for application development.

  • Entity Data Modeler (EDM): Design and define domain models using the Entity Data Modeler tool.

Entity Data Modeler

Business Processes Management

The codbex platform offers a wide range of BPM features, including BPMN modeling, process execution, task management, and administrative tools. By leveraging these features, organizations can streamline their business processes, improve operational efficiency, and achieve better visibility and control over their business operations.

BPMN Modeler

System Integrations and ETL

The codbex platform offers a rich set of ETL features, including visual route modeling, integration engine based on Apache Camel, extensive library of connectors, and comprehensive admin tools. These features empower users to design, deploy, and manage complex data integration workflows with ease, enabling organizations to efficiently extract, transform, and load data across their IT landscape.

Routes Modeler

Form Designer

The Form Designer in the codbex platform offers a flexible and intuitive solution for designing input forms, enabling users to create visually appealing and highly functional forms for their applications with ease. Whether building simple data entry forms or complex multi-step workflows, the Form Designer provides the tools and capabilities needed to design engaging and user-friendly interfaces for a wide range of business use cases.

Form Designer

Extensibility in the Platform

  • Overview: Explore the extensibility features of the platform, including extension points and extensions.

  • Extension Points: Identify and leverage extension points to customize and extend platform functionality.

  • Extensions: Develop and deploy extensions to enhance the capabilities of the platform.