Skip to content

Getting Started ​

Overview ​

This guide will help you get started with the Collage Brand Portal development.

Prerequisites ​

  • Node.js >= 18.x
  • npm, pnpm, yarn, or bun
  • Git

Installation ​

  1. Clone the repository:
bash
git clone <repository-url>
cd brand-portal
  1. Install dependencies:
bash
npm install
# or
pnpm install
  1. Create .env file with required environment variables (see main README)

  2. Start development server:

bash
npm run dev

Project Structure ​

  • app/ - Application source code
  • server/ - Server-side code
  • public/ - Public static files
  • nuxt.config.ts - Nuxt configuration

Development Workflow ​

  1. Create feature branch
  2. Make changes
  3. Test locally
  4. Commit changes
  5. Create pull request

Next Steps ​