IndieShip

Get Started

Note: Documentation Work In Progress

1. Get IndieShip

2. To get started, clone the cleaned git repo using degit

# Clone the git repo
git clone https://github.com/get-indieship/indieship [YOUR_APP_NAME]

# Go inside your directory
cd [YOUR_APP_NAME]

# Remove the git repo
rm -rf .git

# Reinitialize git (optional, but recommended)
git init

# Then, install the packages
bun install

3. Copy .env.local.example to .env.local and .env.prod

cp .env.local.example .env.local
cp .env.local.example .env.prod
  • Fill the environment variable values
  • .env.local is for your local development environment
  • .env.prod is for the production app
bun run husky
  • It is okay not to use Husky, but I recommend it.
  • Learn more about husky
  • Learn more about package.json and hooks

5. Run the dev server and Convex dev server

Open your terminal and create two separate terminal tabs using cmd + t and type:

# In your Terminal tab 1
# For local dev
bun run dev
# In your terminal tab 2
# For Convex dev server
bun run dev:convex

# Note: After you run dev:convex for the first time, 
# you will be asked to fill environment values of the convex site
# just follow the instructions

6. Done!

You can start coding and ship fast or continue reading this documentation for a better understanding of the codebase.

packages.json and hooks

Next Page

On this page

Note: Documentation Work In Progress1. Get IndieShip2. To get started, clone the cleaned git repo using degit3. Copy .env.local.example to .env.local and .env.prod4. Run the git hook (recommended)5. Run the dev server and Convex dev server6. Done!