Quick Start

Install

StarterStack uses a menu driven installer. Please have your license key ready.

mkdir my-product-app
cd my-product-app
npx starterstack.io

You will see the following prompt:

Need to install the following packages:
[email protected]
Ok to proceed? (y)

Follow the prompts to complete your installation.

Startup

Next, let's start up your Docker containers and local frontend dev environment:

cd my-product-app/infrastructure
docker compose -p my-product-app up -d --build

Note

This will take a few minutes.

Finally, let's run the database migrations which will create the initial schema and populate it with test data.

docker exec my-product-app-backend npm run init-db

At this point you now have 3 running Docker containers:

Container	Description	Location
my-product-app-frontend	Vue frontend based on my-product-app/frontend/dist	http://my-product-app-www.localhost:7080
my-product-app-api	Node backend based on my-product-app/backend	http://my-product-app-api.localhost:7080
my-product-app-db	database	localhost:7033

You can see this by running:

docker ps

Starting Your Local Frontend Dev Env

The frontend is a standard Vite + Vue3 stack which let's you take advantage of Hot Reloads.

cd my-product-app-frontend/frontend
npm run dev

You can begin coding and you will see your changes real-time in the browser @ http://localhost:5173

INFO

This frontend will still connect to the backend Docker container my-product-app-api

Logging in to Your App

StarterStack comes with an initial database schema and some test data. If you ran the migrations earlier, you will have created 20 test users in the Users table.

All of the user passwords have been set to 1234. Here are a few users you can use to login.

first name	last name	email	password
Kaci	Lesch-Ankunding	[email protected]	1234
Brianne	Schoen	[email protected]	1234
Carissa	Osinski	[email protected]	1234