Docs
Getting started

Your first app

View Markdown

Start with one screen that calls a Python function. You will enter text in a form and see the cleaned text and its character count come back.

After installation, create a workspace:

mkdir my-app
cd my-app
vortexify init --name my-app
vortexify create api normalize
vortexify create app dashboard

Open the workspace in Codex, Claude Code, or your preferred coding agent. Initialization adds project guidance for those harnesses. Other harnesses can follow the same instructions. Ask it to inspect the generated API and app before editing them.

The API starter already trims text and returns its length. Save it and prepare it to run:

vortexify commit --type api --resource normalize
vortexify build api normalize --wait

A commit saves the API source; the build prepares that saved version's preview runtime. Editing the local Python file afterward does not change the running backend until you commit and prepare it again. The platform lets you inspect the saved API and its build/run results alongside your local workspace.

Start the app:

cd apps/dashboard
npm install
vortexify dev

Open the URL printed by Vortexify. In the starter's API resource field, enter normalize. Enter Hello in the value field and submit. You should see:

{"value": "Hello", "length": 5}

You now have a React interface calling a Python backend. Ask your coding agent to adapt the form and response to your own idea. The app's src/App.tsx contains the interface; apis/normalize/main.py contains the backend. These are default locations; your project configuration controls the paths.

As you edit the backend, commit it; prepare the runtime again when the saved version needs a new dependency image or allocation. Frontend edits appear through the local development server. Use the platform alongside your workspace: open normalize in Playground, select History, and inspect the request output and logs. The Code view lets you compare working source with saved versions.

Next: Put the pieces together or build your interface. Publish when you want other people to use it.