Getting started
Quick start
From sign-up to a first verified flow: create an organization or project, put two systems on the map, connect them with a checked API, give it logic, and prove it with a test case.
Open System map in the appBefore you start
This guide takes about fifteen minutes. You build the smallest useful thing: a web app that calls one API on a backend service, with logic behind the API and one test case that proves it. Each step links to the guide with the details.
If you would rather follow every click and value for a real journey, use the step-by-step examples. The login example builds four systems, two pieces of logic and five test cases.
1. Create your account and organization
- Go to sign up. Fill in First name, Last name, Email and Password (at least 8 characters), and click Continue.
- Verify your email: open the link in the email Rabbinatix sent you. If you opened it on another device, come back and click I’ve verified.
- Choose who it is for: Just me makes your Personal workspace, With my team makes an organization.
- For an organization, type the Organization name. The URL fills in from it; change it if you like.
- Under What best describes you?, pick the closest answer.
- Click Create Personal or Create organization. Your first project's Dashboard opens.
Already have code? Tick I already have code to put on the map before step 6. Instead of the dashboard, AI assistants opens with Connect your assistant: make the key, paste the snippet into your editor, and ask it *Put this repo on Rabbinatix.* Its drafts wait on Drafts until you accept them. The rest of this guide builds a map by hand.
If a team has already invited you, the same page leads with its invite, under Invitations: click Join <organization name>. To make an organization of your own instead, click or create your own organization below it. See Organizations and Personal.
Rabbinatix opens only once your email address is verified. Until then every page shows Verify your email, with Resend email (one email every 3 minutes; the button counts down) and I’ve verified. Can't find the email? Look in your spam folder. Signed up with the wrong address? Sign out, then sign up again with the right one. Signing in with Google or your organization's single sign-on needs no link.
2. Add two systems
- On the dashboard, click Go to the system map, or open System map in the sidebar.
- Click System in the toolbar. Name it
Web App, set Type toWeb frontend, and click Create system. - Click System again. Name it
Orders Service, set Type toBackend service, and click Create system.
The map now shows two systems with no line between them. See Systems.
3. Declare an API
The provider declares what it offers.
- Open Systems in the sidebar and click
Orders Service. Go to its APIs tab and click Add an API. - Under Basics, set Method to
GET, Path to/api/v1/orders/{id}and Lifecycle toTo do. - Under Responses, the 200 card is already there. Type its body:
id: integer
status: enum(open, paid, shipped)- Click Create endpoint.
See APIs and contracts.
4. Connect the systems
- Click New beside search, then Connect systems.
- Set Consumer · depends on the API to
Web Appand Provider · exposes the API toOrders Service. - Tick
GET /api/v1/orders/{id}and click Connect 1 API.
On the map you can also drag the + handle from one system to another to open the same dialog.
5. See the contract check
A line now joins Web App to Orders Service. Rabbinatix compared what the web app expects with what the service provides, field by field. Click the line to see the connection, then the API to see the contract.
A healthy contract means both sides agree. A broken one shows the exact field that differs. An expectation nobody provides yet shows as unresolved, which is not a failure. See Contract statuses.
6. Give the API logic
- Open
Orders Serviceand go to APIs. - On the
GET /api/v1/orders/{id}row, click Logic (its tooltip says Implement with logic). The logic editor opens with an On Request start shaped like the request. - Add a Return Response node with status
200, and connect the start's arrow into it. - Add a Make Object node with the fields
id: integerandstatus: string. Connect theidfrom the request, typeopenas the status, and connect the object into the response body. - Check that the Problems tab is empty.
To read the logic as text, open the Text steps tab. See Logic and the logic editor reference.
7. Add a flow and a test case
- Open Flows in the sidebar and click New flow.
- Name it, set Where does the flow start? to Existing logic, pick the Orders Service logic, and click Create flow. The flow draws its lanes from the logic.
- In the flow's Test panel, click Manage…, then New.
- Fill in Name, and under Input type an Inline value, for example
{ "id": 1 }. - Under Expected response, click New expected result and say what a correct answer looks like, for example
statusequals"open". - Click Save test case.
See Flows and Test data and expected results.
8. Run it
- On the flow, click Test, then Run all.
- A passing test case turns green. A failing one points at the first step that went wrong. Fix that logic and run again.
- When all pass, open … and pick Check the generated code. It runs the generated code against the same test cases.
See Test cases and runs.
9. View the generated code
Open the logic again and click Code in the toolbar (Ctrl+Shift+C). The Code panel shows TypeScript, Python, C#, Java, Go, Kotlin, Swift, Dart, PHP, Ruby or Rust that does exactly what the logic does. See Code generation.
Start from a template instead
You don't have to build everything by hand.
Related
- Organizations and PersonalWhere your work lives. An organization for a team, and your own Personal workspace for yourself; each holds projects. Switch between them, and turn Personal into an organization when others join.
- The system mapYour systems and the connections between them on one canvas, coloured by contract health, with a table and a Connections view.
- FlowsBuild a flow from the logic it starts at, see it cross your systems in lanes, and move it from draft to verified.
- Test cases and runsWrite test cases as acceptance tests, run the flow and watch it move through your systems, step back in time, and compare runs and versions.
- Step-by-step examplesEvery click and value to build a login flow, a system map, logic and a whiteboard.
