Quick Start
Thank you for choosing ShipAny, a NextJS development scaffold for rapidly developing AI SaaS projects.
Get ShipAny Code
- Purchase from ShipAny official website
- After payment, enter the order center
Select the order to activate.
- Bind your Github Username for activation
- After successful activation, you will receive an invitation in your Github notification center. Click to join the ShipAny code repository
Pull Project Code
- Enter the ShipAny code repository (if you haven’t joined, it will show 404)
https://github.com/shipanyai/shipany-template-one
- Choose git clone method, or directly download the source code to your local computer
git clone [email protected]:shipanyai/shipany-template-one.git my-shipany-project
Install Project
- Enter the project root directory
cd my-shipany-project
- Install project dependencies
pnpm install
Development and Debugging
- Copy environment variable configuration file
cp .env.example .env.development
- Start development server
pnpm dev
- Local preview
Open http://localhost:3000 in your browser to preview your project
Customization
Modify Web Colors
- Choose a shadcn theme debugger
- Create a theme color scheme for your project:
- Copy the theme styles and paste them into the project file:
app/theme.css
- Re-enter the project preview page to see your customized theme
Modify Landing Page Content
- Open the landing page content file, use AI to generate new landing page content
- Apply the AI-generated new landing page content, make minor manual adjustments, and preview the new landing page
- Continue adjusting other json files under
i18n/pages/landing
to make the webpage content match your project.
Modify Multilingual Text
In the i18n/messages
directory, configure page content through [locale].json
files. Chinese and English are supported by default. In the i18n/messages/
directory, you can see en.json
and zh.json
files. Before project release, modify the content to match your project.
You can use AI to assist in generating content:
update content of this file, for my new project "Flux AI", which is an AI Image Generator, with keywords "flux ai, ai image generator"
Modify Website Policies
Before officially launching the website, please update the website policies in the app/(legal)
directory according to your website’s services.
- Update Privacy Policy
In Cursor, generate new privacy policy content using prompts.
update privacy-policy according to landing page content @en.json
with brand name "ShipAny", domain "shipany.ai", contact email is "[email protected]"
Replace the content in app/(legal)/privacy-policy/page.mdx
to update the privacy policy.
- Update Terms of Service
In Cursor, generate new terms of service content using prompts.
update terms-of-service according to landing page content @en.json
with brand name "ShipAny", domain "shipany.ai", contact email is "[email protected]"
Replace the content in app/(legal)/terms-of-service/page.mdx
to update the terms of service.
Modify Environment Variables
Modify environment variables according to actual needs to enable data storage / login / data analytics / payment and other features
# -----------------------------------------------------------------------------
# Web Information
# -----------------------------------------------------------------------------
NEXT_PUBLIC_WEB_URL = "http://localhost:3000"
NEXT_PUBLIC_PROJECT_NAME = "ShipAny"
# -----------------------------------------------------------------------------
# Database with Supabase
# -----------------------------------------------------------------------------
# https://supabase.com/docs/guides/getting-started/quickstarts/nextjs
# Set your Supabase URL and Anon Key
SUPABASE_URL = ""
SUPABASE_ANON_KEY = ""
# -----------------------------------------------------------------------------
# Auth with next-auth
# https://authjs.dev/getting-started/installation?framework=Next.js
# Set your Auth URL and Secret
# Secret can be generated with `openssl rand -base64 32`
# -----------------------------------------------------------------------------
AUTH_SECRET = ""
# Google Auth
# https://authjs.dev/getting-started/providers/google
AUTH_GOOGLE_ID = ""
AUTH_GOOGLE_SECRET = ""
NEXT_PUBLIC_AUTH_GOOGLE_ENABLED = "false"
NEXT_PUBLIC_AUTH_GOOGLE_ONE_TAP_ENABLED = "false"
# Github Auth
# https://authjs.dev/getting-started/providers/github
AUTH_GITHUB_ID = ""
AUTH_GITHUB_SECRET = ""
NEXT_PUBLIC_AUTH_GITHUB_ENABLED = "false"
# -----------------------------------------------------------------------------
# Analytics with Google Analytics
# https://analytics.google.com
# -----------------------------------------------------------------------------
NEXT_PUBLIC_GOOGLE_ANALYTICS_ID = ""
# -----------------------------------------------------------------------------
# Analytics with OpenPanel
# https://openpanel.dev
# -----------------------------------------------------------------------------
NEXT_PUBLIC_OPENPANEL_CLIENT_ID = ""
# -----------------------------------------------------------------------------
# Payment with Stripe
# https://docs.stripe.com/keys
# -----------------------------------------------------------------------------
STRIPE_PUBLIC_KEY = ""
STRIPE_PRIVATE_KEY = ""
NEXT_PUBLIC_PAY_SUCCESS_URL = "http://localhost:3000/my-orders"
NEXT_PUBLIC_PAY_CANCEL_URL = "http://localhost:3000/#pricing"
Deploy Online
- Create Github Repository
Please make sure to select a private repository. Do not publicly release ShipAny’s code, reject piracy.
- Submit the modified project code to the project Github repository
git remote set-url origin https://github.com/your-username/your-project-name.git
git add .
git commit -m "update landing page"
git push origin main
- Create a new project in the Vercel console, import the code repository, and deploy with one click
- After the build is complete, you can see your project in the Vercel console
- Open the domain to access your project