💡How to get started

Our goal at K3 Labs is to make blockchain simple. To this end, K3 Labs platform offers a Web2 user-friendly setup tools for businesses and developers easily design and deploy business workflows and applications that utilize the power of decentralized compute, storage, and execution. This guide covers signing up for a K3 Labs account, creating a team, setting up your application on-chain, releasing deployments, managing databases and billing.

Key Sections:

1. Sign Up for an Account

2. Create a Team

3. Deploy Your First Project

4. Manage Your Project

5. Deployments Management

Sign Up for an Account

First, you need to create a K3 Labs account to start using our services. If you already have an account, you can skip to the next section.

1. Open a web browser and navigate to https://app.k3-labs.com/login.

2. Enter your email address, a unique username, and a strong password. Alternatively, you can sign up using your existing Google or GitHub account. When using another provider, you are prompted for a username in a separate step.

Create a team

A team is an account where multiple users can collaborate and manage their projects.

To create a team, you need to enter your team name and press “Finish”.

Set up your first project

A Project in K3 Labs is an application/service deployed on the blockchain via K3 Labs platform. To create a project, you need to open https://app.k3-labs.com/launch and select either an empty project or a project from templates. Project templates allow users to quickly set up an app/service tailored to a specific use case (i.e. On-chain data publishing).

To create an empty project, you need to pass the following stages:

1. Details:

   1. Project title: Enter your desired project title.

   2. Project template: Select your desired development language (Rust or React.js)

2. Import. Here you can import your existing GitHub project by:

   1. Import Git Repository

   2. Or Enter the URL of a Git repository

3. Deployment

To create a project, you first need to connect a GitHub account to allow our platform to read and create repositories on your account. It is possible to either create a project from an already existing repository or create a new one by entering the URL of a public repository (this will creat a new repository on your GitHub account).

To create a project from templates, you need to pass the following stages:

Select a Template from a list of available templates. Enter the key data based on the inputs in the template and deploy the project.

After creating a project a Deployment will automatically be created, and will redeploy on each change for the selected branch.

Manage Your Project

After your project is created, you will be able to access the project page by going to https://app.k3-labs.com/projects and choosing the desired project. Within each project page, you will be able to access key information about your project and manage it.

Key information accessible through a project page is:

1. Environmental Variables

2. Github / Domain Links (if applicable)

3. Latest deployment details

4. Active Branches

5. Latest activity

You can also create New Deployment by pressing “+ New Deployment”. This will open up a pop-up, where you can fill in Deployment name, select a branch you want to deploy from and press “Deploy”.

Deployments Management

Environment Variables

Environment Variables are key-value pairs configured outside your source code.

During the build process, a .env file will be created, containing the above-mentioned environment variables.

All values are encrypted and visible to any user that has access to the Project. It is safe to use both non-sensitive and sensitive data, such as tokens.

Changes to Environment Variables are not applied to previous deployments, they only apply to new deployments.

Changing environment variables will automatically trigger a redeployment.