Skip to content
Docs

Getting started

From a folder on your computer to a link you can send to your team, in five steps and plain words. No servers, databases or login code to set up.

You built something: a tracker for your team, a page of numbers, a small tool. Maybe an AI agent wrote it for you. It works on your computer, and now you want other people to use it. That is what Basemodo does. If you work with an agent, you can also let it do all of this for you: see Deploying with an agent.

What you need

  • The folder with your App in it. Basemodo recognizes most web projects by themselves: a website (a folder with an index.html), a Node.js app (Next.js, Vite, Astro, Express, Hono), a Python app (Django, FastAPI, Flask, Streamlit), or anything with a Dockerfile. The full list is on Supported runtimes.
  • The basemodo command on your computer, and a terminal to type it in. On a Mac the terminal is the app called Terminal; on Windows, PowerShell. You only ever type the commands on this page.

To check the command is there, type this and press Enter:

Terminal window
basemodo --version

It answers with its version, like basemodo 0.1.0.

1. Sign in

Terminal window
basemodo login

Your browser opens on Basemodo. Sign in with your email (Basemodo sends you a link, no password), or with Google or GitHub, then approve this computer. The terminal says who you are signed in as. You do this once per computer: it stays signed in for 30 days. (basemodo login has the details, like signing in over SSH.)

2. Go to your folder

In the terminal, move into the folder of your App. If it is in your Documents folder and called lunch-rota:

Terminal window
cd Documents/lunch-rota

3. Deploy

Terminal window
basemodo deploy

Basemodo packs the folder, sends it, says what it found in it and why (the files it looked at), builds it and starts it. When it is ready, the last line gives your App's address: Live at https://lunch-rota.basemodo.app. The App is named after the folder; to choose another name, add --name, as in basemodo deploy --name team-lunch.

If something goes wrong, the error says what happened and, on a line starting with fix:, exactly what to do; the docs: line links to the explanation. Your previous version, if there was one, keeps running. See Deploying for everything a Deploy does.

4. Open it

Open the address in your browser. Basemodo asks you to sign in first: a new App is Private, so nobody but you can open it. That protection is Basemodo's, not your App's, so your App needs no login of its own.

5. Share it

Invite people by email:

Terminal window
basemodo share ana@example.com ben@example.com

Each of them gets an email with the address. They sign in with that email (or Google, or GitHub, if it uses the same address) and they are in. To let in anyone who has the link and signs in, or everyone without signing in:

Terminal window
basemodo share --visibility link
basemodo share --visibility public

Sharing explains each choice. You can do the same from the App's page on basemodo.com.

Changing it

Edit your App, then run basemodo deploy again in the same folder. Basemodo builds the new version, and switches visitors to it only once it works. If the new version turns out wrong, basemodo rollback brings an earlier one back.

What your App saves on its disk (in /data, where its database lives) stays through every Deploy: see Data.

What next