Skip to main content

Quick Start

1. Create your app from the template​

Copy the template directory and give it your app's slug: /

cp -r app.react-template app.your-slug
cd app.your-slug

2. Replace the slug​

Replace every occurrence of react-app-template with your slug in three files: manifest.yaml****:

alias: your-slug
image: octostar/app.your-slug

frontend/package.json****:

{ "name": "your-slug" }

.github/workflows/docker-build-push.yml****:

IMAGE_NAME: octostar/app.your-slug
CACHE_NAME: octostar/cache:app.your-slug

3. Initialize a git repository​

git init
git remote add origin https://github.com/Octostarco/app.your-slug.git

4. Install dependencies​

# Frontend
cd frontend
npm install --legacy-peer-deps
cd ..

# Backend
python -m venv venv
source venv/bin/activate   # Windows: venv\Scripts\activate
pip install uv
uv pip install -r requirements.txt

--legacy-peer-deps is required because some @octostar/* packages have peer dependency declarations that conflict with npm 7+'s strict resolver.