Skip to content

Quickstart

Yuxiang Huang edited this page Aug 14, 2026 · 12 revisions

Use ScottyStack as a template

https://github.com/new?template_name=ScottyStack&template_owner=scottylabs-labrador

The demo branch includes more example code used by https://stack.scottylabs.org.

You would want to rename all instances of "ScottyStack" to your preferred project name. Using the "Match Case" option provides granular control: replace ScottyStack with the public‑facing project name and scottystack with the codebase name. You would also want to exclude *.md files to prevent links within them from breaking.

Dev Container Setup Guide

Prerequisites: Docker and Dev Containers Extension.

  1. Clone and open the repository locally in VS Code (or any other IDE that supports Dev Containers).

  2. Click on the Reopen in Container button that pops up in the bottom left corner of the VS Code window.

    • Or open the command palette and run the command Dev Containers: Reopen in Container.
  3. Wait for the container to start. It may take a few minutes to install dependencies and run post create script.

  4. Install recommended extensions. You can view them by opening the command palette and run the command Extensions: Show Recommended Extensions.

  5. Visit the README files in the corresponding folder to start developing!

Troubleshooting

Dev Container Installation Issues

Check if the Docker Desktop version is up to date.

Port in Use Error

If you see "port in use" error, use lsof -i :<PORT> to find the process using that port and kill it with kill -9 <PID>.

Windows

The dev container using Docker should mostly work on Windows, but we will add more tips here as we gather more data from Windows setups.

Post Create Script Failure

If the post create command in dev container fails, you can manually run the post create script in the container by running the following command in the root directory:

./.devcontainer/post-create.sh

Script Setup Guide

Prerequisites: Docker and Homebrew.

Replace step 4 and 5 in Dev Container Setup with:

  1. docker compose -f .devcontainer/docker-compose.yml up -d

    • Environment variables such as DATABASE_URL needs to be changed.
      • E.g. DATABASE_URL="postgresql://postgres:donotuseinprod@localhost:5432/scottystack"
  2. Run .devcontainer/post-create.sh

Clone this wiki locally