Get Started

Hey maker, welcome to ShipKwiq 👋

Here's a quick overview of the boilerplate. Follow along to get your app up and running.
Let's build a startup, Kwiq ⚡️

Start a local server

1. Make sure you extract the folder and open it in your favourite code editor, then run the following commands one-by-one:

pnpm install
git remote remove origin
cd src
npx prisma generate
pnpm run dev

ShipKwiq requires Node 18.17 or greater. Type node -v in your terminal to check version.

2. Rename .env.example to .env

mv .env.example .env    

3. Open http://localhost:3000 to see your site. And voila!

If you've any issues running the app, just add auth secret to the .env file.

AUTH_SECRET="anything-here"

NextJS project structure

📁 /actions → auth actions

📁 /ai → ai setup

📁 /app → auth folder, api folder, dashboard (just for example)

📁 /components → all the components

📁 /libs → all the helper funtions

📁 /prisma → setup and models

.env file

Rename the .env.example file to .env.local. Change NEXTAUTH_SECRET to anything else. The file content should look like this:

DATABASE_URL=
AUTH_SECRET=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
RESEND_API_KEY=
GROQ_API_KEY=
RAZORPAY_KEY_ID=
RAZORPAY_KEY_SECRET=

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