Installation Guide

Launch Coddy on your machine.

This page walks through local and production setup for the Coddy project, including installation, environment variables, deployment preparation, and packaged asset notes for marketplace delivery.

Requirements

Make sure these pieces are ready before you begin:

Node.js and npm Use a recent Node.js version that works with Next.js 16 and Prisma.
PostgreSQL database The app expects a PostgreSQL connection string, with Neon recommended in the project template. Use a Neon IPv6-supported connection string.
API keys Prepare a Together AI API key for the core generation flow, plus any optional provider credentials for the extra integrations you want to enable.
Git Git is needed to clone the repository locally.

Server Requirements

Operating System Linux-based hosting such as Ubuntu is recommended for production deployment.
Node.js Install a modern Node.js version compatible with Next.js 16 and Prisma.
Memory At least 2 GB RAM is recommended for smooth installs, builds, and runtime stability.
Storage Keep at least 5 GB of free disk space for the app files, dependencies, and build output.
Database Use a Neon PostgreSQL database with an IPv6-supported connection string.
Process Manager PM2 is recommended to keep the Node.js app running in production.
Web Server Nginx is recommended as a reverse proxy for your domain and SSL configuration.
SSL Certificate Your production domain should use HTTPS with a valid SSL certificate.

Installation

  1. Download the project package from CodeCanyon.
  2. Extract the ZIP file on your local machine.
  3. Open the extracted project folder in your terminal.
  4. Copy the example environment file into a real .env file.
  5. Install dependencies with npm.
cd Coddy
copy .example.env .env
npm install
The project runs prisma generate after install, so your dependency install also prepares the Prisma client automatically.

Environment Variables

Start with .example.env and fill in the values that match the features you want to use. The packaged template documents the following settings:

  • TOGETHER_API_KEY for the main AI generation provider.
  • HELICONE_API_KEY for optional observability.
  • MODELSLAB_API_KEY for ModelsLab-backed models.
  • CSB_API_KEY for CodeSandbox and Sandpack preview features.
  • DATABASE_URL for Prisma and PostgreSQL, with Neon suggested. Use the IPv6-supported Neon connection string.
  • NETLIFY_CLIENT_ID if you want the Netlify connect flow.
  • VERCEL_CLIENT_ID and VERCEL_CLIENT_SECRET for Vercel OAuth.
  • NEXT_PUBLIC_VERCEL_APP_CLIENT_ID and VERCEL_APP_CLIENT_SECRET for Sign in with Vercel.
  • UPTIMEHUB_API_KEY for uptime monitoring integration.
  • MICROLINK_API_KEY for optional URL preview metadata.
  • NEXT_PUBLIC_SITE_URL for absolute callback and redirect URLs.
  • NEXT_PUBLIC_PLAUSIBLE_DOMAIN for optional Plausible analytics.
  • NEXT_PUBLIC_DEVELOPMENT_URL for a non-Vercel development URL override.
  • STRIPE_* variables for billing support.
  • BUNNY_* variables for preview thumbnails and media storage.
TOGETHER_API_KEY=your_key_here
MODELSLAB_API_KEY=your_key_here
CSB_API_KEY=your_key_here
DATABASE_URL=your_neon_ipv6_supported_connection_string
NEXT_PUBLIC_SITE_URL=http://localhost:3000
If you are using Neon, make sure your DATABASE_URL is the IPv6-supported connection string, then run the Prisma migration command before starting the app.

Run Locally

Once your dependencies and environment variables are in place, start the development server:

Before the first signup, open your Neon dashboard and go to Auth to Configuration under Authentication. Make sure Verify at Sign-up is disabled before creating the first account. 
npm run migrate:deploy
npm run dev

After the server starts, open http://localhost:3000 in your browser. If the app needs database tables that are not created yet, run your Prisma migration workflow before testing deeper features.

For the first admin setup, visit /admin after the app is running and create your admin password there. Then go to /admin/dashboard/site and disable admin signups so no other users can register as admins.

Production Installation

To deploy this project in production, upload the extracted CodeCanyon package to your server, configure the production environment variables, install dependencies, build the app, and start it.

  1. Upload the project files to your VPS, cloud server, or hosting environment.
  2. Create a production .env file with your live database, domain, and service keys.
  3. Install dependencies on the server.
  4. Run the Prisma migrations for production.
  5. Build the Next.js application.
  6. Start the production server.
copy .example.env .env
npm install
npm run migrate:deploy
npm run build
npm run start
Set NEXT_PUBLIC_SITE_URL to your live domain and use your production DATABASE_URL and live service credentials before building. If you use Neon, choose the IPv6-supported connection string first, then run migrations.

Assets and Licensing

Review every bundled third-party asset before publishing the item on a marketplace. The package currently includes font files in public/Aeonik/.

  • Make sure you have redistribution rights for every included font, image, and icon set.
  • If your license does not allow redistribution, replace the asset before packaging the final download.
  • Keep a credits or license section in your documentation for any third-party resources you include.
Recommended credits entry: Aeonik font files in public/Aeonik/, used under your commercial redistribution license if applicable.

Support

Provide customer support through your CodeCanyon support channel, item comments, or the contact method published on your author profile. Update this section before listing the item so buyers know exactly where to reach you.