# Documentation

> What the platform does, how a deployment runs from push to live, what your app needs, and where to start with your first Express app.

Orbit runs your Node.js app from a GitHub repository. You connect the repository once. After that, every push to your branch is built and put online, with HTTPS, logs and a way back to an earlier version.

You do not set up servers and you do not write a Dockerfile.

## Start here

- [Quick start](https://arrangic.com/docs/quick-start.md): Put an Express app online from a GitHub repository, step by step: sign in, connect the repository, deploy, and what to do if it does not go live.
- [Check your app with AI](https://arrangic.com/docs/check-your-app.md): A prompt for your AI coding assistant. It checks your app against the platform, tells you what to change, and changes only what you approve.
- [Express](https://arrangic.com/docs/frameworks/express.md): What an Express app needs to run on the platform: the port and address, the start command, TypeScript, data and files, with a small example.

## All pages

**Get started**

- [Quick start](https://arrangic.com/docs/quick-start.md): Put an Express app online from a GitHub repository, step by step: sign in, connect the repository, deploy, and what to do if it does not go live.
- [Check your app with AI](https://arrangic.com/docs/check-your-app.md): A prompt for your AI coding assistant. It checks your app against the platform, tells you what to change, and changes only what you approve.

**Deploy guides**

- [Express](https://arrangic.com/docs/frameworks/express.md): What an Express app needs to run on the platform: the port and address, the start command, TypeScript, data and files, with a small example.
- [Other frameworks](https://arrangic.com/docs/frameworks/more.md): Which frameworks run on the platform today (Express on Node.js), and which ones are planned: Next.js, Nuxt, React and Laravel.

**Build and deploy**

- [Deployments](https://arrangic.com/docs/deployments.md): What starts a deployment, what happens in each step, what each status means, and how to cancel, roll back, restart or pause.
- [Build settings](https://arrangic.com/docs/build-settings.md): The Node version, the package manager, the commands and the port of an app, how each is chosen from your repository, and the limits of a build.
- [Deploy commands](https://arrangic.com/docs/deploy-commands.md): Commands that run once for every deployment, before the new version takes traffic. The place for database migrations.
- [Environment variables](https://arrangic.com/docs/environment-variables.md): Settings and secrets for your app: how to add them, when they apply, which ones are set for you, who sees their values, and the limits.

**Run your app**

- [Sleep and wake](https://arrangic.com/docs/sleep-and-wake.md): An idle app can sleep and wake on the next request. What that costs, what it saves and what an app loses while it sleeps.
- [Scaling](https://arrangic.com/docs/scaling.md): How much compute a replica has, how many replicas an app may run, how many requests a replica takes at once, and where the app runs.
- [Domains](https://arrangic.com/docs/domains.md): The address every app gets, how to add a domain of your own with its DNS records, a domain behind your own proxy, HTTPS, and what does not work.
- [Logs and crashes](https://arrangic.com/docs/logs.md): Where to read what your app prints, where the build log is, and what happens when an app keeps crashing.

**Team and billing**

- [Teams](https://arrangic.com/docs/teams.md): Who can do what in a team as owner, admin or member, how to invite people, which notifications the team gets, and where to see what changed.
- [Billing](https://arrangic.com/docs/billing.md): What you pay for on a plan, how compute and bandwidth are counted, what costs nothing, and where to see your usage and invoices.

**Help**

- [Troubleshooting](https://arrangic.com/docs/troubleshooting.md): The messages you may see when a build, a start or a domain fails, what each one means and what to do.

**Updates**

- [Changelog](https://arrangic.com/docs/changelog.md): What is new on the platform and what got better, day by day and newest first. Small fixes and changes you would not notice are left out.

## How it works

![A push is built, released and then live](https://arrangic.com/docs/img/deployment.svg)

1. **You push.** A push to the branch you chose starts a deployment. You can also start one by hand.
2. **It is built.** Your packages are installed and your build command runs. The build log is kept with the deployment.
3. **It is released.** Your deploy commands run (a database migration, for example), then the new version starts. If it does not start, the version that was running stays online.
4. **It is live.** The app answers at its address. When nobody visits, it can sleep, and it wakes on the next request.

## What you need

- A GitHub repository with an Express app in it.
- A `package.json` at the top of the repository, or in one folder of it.
- A server that listens on the port in the `PORT` variable.

Not sure your app fits? [Check your app](https://arrangic.com/docs/check-your-app.md) gives you a prompt for your AI coding assistant. It reads your code, tells you what to change, and changes nothing without your yes.

## What runs today

Express apps, on Node.js 18, 20 or 22.

Next.js, Nuxt, React and Laravel are planned and not available yet. See [Other frameworks](https://arrangic.com/docs/frameworks/more.md).

---

This page on the site: https://arrangic.com/docs  
All pages of the documentation: https://arrangic.com/llms.txt
