Quick start ⚡️

Hey maker, welcome to ShipQuick 👋

Here's a quick overview of the boilerplate. Follow along to get your app up and running.

Once you're done, start with the tutorial to launch your project in 5 minutes. Let's build that startup, FAST ⚡️

Start a local server

  1. In your terminal, run the following commands one-by-one:
git clone https://github.com/your-username/shipquick.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
pnpm install
git remote remove origin
pnpm dev

ShipQuick requires Node 20 or greater. Type node -v in your terminal to check version.

  1. Rename .env.example to .env
mv .env.example .env
  1. Open http://localhost:5173 to see your site. And voila!

You will see errors in the console (like missing database connection) but nothing important for now.

Next steps

Now go ahead and follow the tutorial to get your startup live within 5 minutes!