CMS Template Documentation
This guide explains how to install, customize, and deploy a BloomTPL CMS template built with Next.js 15, Tailwind CSS, shadcn/ui, and Sanity.io.
1. Installation
- Download the template: After purchase, download the ZIP file and extract it to your workspace.
- Install dependencies:
npm install
- Set up environment variables: Copy
.env.example
to.env
and fill in your Sanity project details.cp .env.example .env
SANITY_PROJECT_ID
– Your Sanity project IDSANITY_DATASET
– Your Sanity dataset nameSANITY_API_TOKEN
– Your Sanity API token (if needed for write access)
- Start the development server:
Your app will be running atnpm run dev
http://localhost:3000
. - Set up Sanity Studio (optional): If your template includes a Sanity Studio, navigate to the
/studio
folder and run:
This will start the Sanity Studio for content management.npm install && npm run dev
2. Customization
- Edit content: Manage your site’s content in Sanity Studio. Changes will be reflected instantly in your Next.js app.
- Edit pages and components: Modify files in the
/app
and/components
directories to update layout, styles, and structure. - Change styles: Update Tailwind CSS classes directly in your JSX. You can also edit
tailwind.config.js
to customize your color palette, fonts, and breakpoints. - Use shadcn/ui components: All UI elements use shadcn/ui. You can add new components by running:
Replacenpx shadcn-ui@latest add [component]
[component]
with the desired UI element (e.g.,button
,card
). - Update metadata: Edit
app/layout.tsx
and page-levelmetadata
for SEO and social sharing.
3. Deployment
- Build your app:
npm run build
- Deploy to your preferred platform: You can deploy to platforms like Netlify, AWS Amplify, Render, or your own server. Make sure to set
NODE_ENV=production
and runnpm run build
before serving. - Set environment variables: Ensure your production environment has all required variables from
.env
. - Deploy Sanity Studio (optional): You can deploy your Sanity Studio separately using Sanity’s deployment guides.
Troubleshooting & Tips
- If you see build errors, check your Node.js version (Next.js 15 requires Node 18+).
- For Sanity integration issues, see the Sanity docs.
- For shadcn/ui issues, refer to the official documentation.
- For Tailwind CSS customization, see the Tailwind docs.
Need Help?
If you have any questions or run into issues, contact our support team at bloomtpl@gmail.com.