# Getting started

> Your first product in a few minutes. Sign up, choose a template, name your product and let Orkosi deploy it.

Source: https://support.orkosi.com/docs/getting-started

This guide walks through the four steps every new customer takes: create an account, choose a template, name your product, and let the platform build and deploy it. When you finish, you will have a live product at its own `orkosi.app` address and a dashboard to run it from.

## Before you begin
- **An invite code.** Orkosi is in beta. Registration asks for an invite code. If you do not have one, request access from [orkosi.com/register](https://orkosi.com/register) or email [hello@orkosi.com](mailto:hello@orkosi.com).
- **An email address you can read now.** You confirm it right after signing up.
- **Ten minutes.** The wizard itself takes two or three; provisioning runs in the background while you finish it.

## Step 1: Sign up
Go to [orkosi.com/register](https://orkosi.com/register) and enter your email, a password and your invite code. The password meter has to show a strong password before the form submits.

After registering you land on the email confirmation screen. Open the message from Orkosi and follow the link. If it does not arrive within a couple of minutes, check your spam folder or ask for a new one from the confirmation page.

> **Note:** Two-factor authentication is offered at sign-in, not at sign-up. Some roles are required to enrol a TOTP app the first time they log in. You can enable it for your own account at any time from **Settings**.

## Step 2: Choose a template
The onboarding wizard opens automatically after your first sign-in (you can always return to it at `orkosi.com/onboarding/wizard`). It has seven short steps:

1. **Brand name** — the name of the product you are building.
2. **Template** — what kind of product it is (see below).
3. **Style** — a brand preset: colours, fonts and tone that the agents will follow.
4. **Customise** — adjust the palette, fonts and industry.
5. **Business info** — a line about what the product does and who it is for.
6. **Logo** — upload one or let Orkosi generate options.
7. **Review** — confirm and launch.

At the template step you pick one of:

| Template    | Best for                                         | What you get                                                                                                |
| ----------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| **SaaS**    | Web applications with accounts and subscriptions | Auth, Stripe billing, teams and roles, admin dashboard, transactional email                                 |
| **Shopify** | Online stores                                    | Catalogue, product pages, cart and checkout, orders, customer accounts                                      |
| **Website** | Company sites, landing pages, blogs, portfolios  | Multi-page site, blog, forms and editor. Landing page, Blog and Portfolio are variants of it, not templates |
| **Mobile**  | iOS and Android apps                             | Expo/React Native app with auth, navigation and a web preview                                               |
| **Desktop** | macOS and Windows apps                           | Tauri desktop app with installers and a web preview                                                         |

Already have a website? Choose **I already have a website** instead. Orkosi imports your site, extracts the brand and pre-fills the wizard.

Read the [Templates guide](https://support.orkosi.com/docs/templates) for a full comparison.

## Step 3: Name your product
The brand name you typed in step 1 becomes your product's **slug**, which is used everywhere: the repository name, the hosting address and the database schema.

The slug is derived automatically:

- lower-cased, with anything other than letters and digits turned into a hyphen (`Acme Analytics` becomes `acme-analytics`),
- at most 48 characters,
- made unique with a short suffix if the name is already taken.

Your product's addresses will be:

| Environment | Address                                                       |
| ----------- | ------------------------------------------------------------- |
| Production  | `https://<slug>.orkosi.app`                                   |
| Development | `https://dev.<slug>.orkosi.app` (plans with two environments) |

You can attach your own domain later. See [Custom domains](https://support.orkosi.com/docs/custom-domains).

## Step 4: Deploy
Setup starts while you are still in the wizard and shows live progress on the review step. Orkosi runs these nine steps for you, named the same way in the wizard panel, the product dashboard and your notifications:

1. **Database** — creating your database: a dedicated schema and login role for your product.
2. **Code repository** — creating the code repository from your template: a GitHub repository created from the template, with your brand applied. It takes seconds.
3. **Website copy** — copying your website: only when you started from an existing website. Its pages, images and fonts are copied into your code page by page, with live progress. A page that does not look exactly like your original yet never stops setup; it shows how similar it is and keeps improving after your product is live.
4. **File storage** — preparing file storage: an S3 prefix for uploads and generated assets.
5. **Web address** — registering the web address: the `orkosi.app` hostnames.
6. **Hosting** — building and deploying your app: the container image is built, pushed and started.
7. **Configuration** — writing the configuration: secrets and environment variables are generated and encrypted.
8. **Verification** — verifying the deployment: the platform waits for the service and probes its health endpoint.
9. **Activation** — activating your product: the product is marked live and starter tasks are created.

A first product usually goes live within a few minutes of finishing the wizard. If a step fails, completed steps are rolled back and the wizard tells you where to retry (**Hosting → Provisioning** in your product hub).

## Your product hub
When provisioning finishes you are taken to the product hub, the home for everything about that product:

- **Dashboard** — health, recent tasks and deploys at a glance.
- **Tasks** — the Kanban board where work is queued, built, reviewed and shipped.
- **Deploy** and **Hosting** — environments, deploy history, promote to production, rollback, logs and metrics.
- **Domains** — attach your own domain.
- **Database** — a read-only browser of your product's data.
- **Brand**, **Tools**, **Marketing** — brand kit, generated assets and growth tooling.
- **Credits**, **Billing**, **Team**, **Settings**.

## Your first task
Open **Tasks** and click **New task**, or simply describe the change to the chat assistant, for example: "Add a pricing page with three plans and a contact form." Orkosi turns it into a task and an agent starts working.

A task moves through five stages that you can follow on the board:

| Stage         | What is happening                                                             |
| ------------- | ----------------------------------------------------------------------------- |
| **Queued**    | Waiting for a free worker slot                                                |
| **Building**  | An agent is implementing the change on a branch of your repository            |
| **Reviewing** | An automated review checks the result; rejected work goes back for a fix pass |
| **Done**      | The change is merged and deployed to your dev environment                     |
| **Failed**    | The task could not be completed; you can re-queue it or edit the description  |

Every stage shows progress and an estimate based on your recent tasks. When the task is done, open `dev.<slug>.orkosi.app` to try it, then promote it to production from **Hosting**. The [Deploy guide](https://support.orkosi.com/docs/deploy-guide) covers that flow in detail.

## Next steps
- [Deploy guide](https://support.orkosi.com/docs/deploy-guide) — dev vs prod, promote, rollback and build times.
- [Billing and credits](https://support.orkosi.com/docs/billing) — what your tasks cost and how to top up.
- [Telegram operations](https://support.orkosi.com/docs/telegram) — run your product from your phone.