Skip to main content

Quick Start

Thank you for choosing ShipNowKit. Let's spend 5 minutes to quickly build your project.

🌟 Get ShipNow Code​

  1. Purchase from ShipNowKit Official Website

  2. After payment, go to the Order Center, enter your GitHub username, and click activate. image.png

Note the difference between name and username. You can directly check your username at https://github.com/settings/profile image.png

  1. After activation, you will receive an invitation in the email associated with your Github account, or you can log into github and directly click this link to enter the invitation page. Click to join the ShipNowKit code repository. image.png

  2. Clone the code locally

git clone [email protected]:dante-is-shipping/shipnow.git [YOUR PROJECT NAME]

🚀 Dependencies Installation and Project Launch​

Install Dependencies​

cd [YOUR PROJECT NAME]
npm install

Copy Environment Variable Configuration File​

mv .env.example .env.local

Database Setup Guide​

  1. Choose your database type
# choose mysql
npm run db:use:mysql
# choose postgresql
npm run db:use:postgresql
# choose mongodb
npm run db:use:mongodb
  1. Fill in database connection information in environment variable DATABASE_URL
# .env.local
DATABASE_URL="xxx"
  1. Database Migration
npm run db:migrate

Local Development and Debugging​

npm run dev

Project Preview​

Open http://localhost:3000 in your browser to preview your project. image.png

📂 Core Directory Structure​

├── app/
│   ├── _templates/       # Contains different style templates
│   ├── api/             # API routes directory
│   ├── payment/         # Payment related pages
│   ├── signin/          # Sign-in related pages
│   └── policies/        # Privacy policy and terms of use
│
├── components/          # Reusable React Components
│
├── config/             # Site Basic Information Configuration
│
├── db/                 # Database Related Files, Including Prisma Client and Tools
│
├── emailTemplate/      # Various Email Templates
│
├── lib/               # Utility Functions and Various Server Actions
│
└── public/            # Various Static Resources