Getting Started
From empty folder to an app colleagues can open.
1. Build a static app
Section titled “1. Build a static app”Most Stackboard apps start in an AI coding assistant. Ask for a static frontend with no backend, since Stackboard serves files from your repository and can’t run a server:
Build a static React app with Vite that shows a sortable table from
data.json. No backend, no server code.
Vite, Astro, or a single index.html all work. If your project has a build
step, commit its output: Stackboard runs what’s in the repository and won’t
build for you.
2. Push to a git provider
Section titled “2. Push to a git provider”git initgit add -Agit commit -m "Initial version"git remote add origin <your-repository-url>git push -u origin mainCommit your build output if you have one, but never API keys. Anything in the repository is readable by whoever opens the app, so credentials go in the app’s secrets instead.
3. Add the app
Section titled “3. Add the app”In Stackboard, choose Add an app and set:
- Repository: choose GitHub, GitLab, or Bitbucket to pick from your own repositories, or choose URL to paste any repository’s address. A private one also needs an access token that can read it, such as a GitHub fine-grained token, a GitLab project access token, or a Bitbucket repository access token. The first time you choose a host, Stackboard asks you to connect it. The connection is yours, appears under Settings → Integrations, and is how Stackboard reads your private repositories. You can connect several accounts on one host and choose which one reads each app’s repository under Account.
- Branch, if not the repository’s default. Pick it from the repository’s branches, or type its name
- Entry file, if your
index.htmlisn’t at the repository root. For a built project this is usuallydist/index.htmlorbuild/index.html - Name, description, and tags for the catalog
- Owner: yourself, or a group
- Publish to the catalog, if others should be able to find it. If your organization requires approval, this asks an admin instead. See Publishing
Stackboard reads the repository as you fill these in. Once it has, secrets and API targets can be set here, or added later. See Developing for Stackboard.
If the page comes up empty, the entry path is usually pointing at the wrong file. See Developing for Stackboard.
4. Share it
Section titled “4. Share it”A new app starts at Internal, open to everyone in the organization. Change it to Specific users or External when you need to. See Sharing.
From here, git push is the whole deploy process, unless you’ve pinned the
app to a release or a commit.
