### Local Development Setup for Compoviz Source: https://github.com/adavesik/compoviz/blob/main/README.md Set up Compoviz for local development using Node.js and npm. Ensure Node.js v18 or higher is installed. ```bash git clone https://github.com/adavesik/compoviz.git cd compoviz npm install npm run dev # Optional - Disable Vercel Analytics: cp .env.example .env ``` -------------------------------- ### Install Dependencies Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Install all necessary npm dependencies for the project. ```bash npm install ``` -------------------------------- ### Start Development Server Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Start the Vite development server for hot-reloading. Optionally, copy the .env.example file to .env to disable Vercel Analytics. ```bash # Optional: To disable Vercel Analytics just copy the .env.example file with: cp .env.example .env ``` ```bash npm run dev ``` -------------------------------- ### Docker Development Environment Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Scripts for managing the Docker development environment, including starting, restarting, rebuilding, and stopping containers. ```bash # Build & Start container (with logging) npm run docker:dev ``` ```bash # Build & Start container (detached) npm run docker:dev -- -d ``` ```bash # Restart running container npm run docker:restart ``` ```bash # Rebuild image and start container npm run docker:rebuild ``` ```bash # Stop and remove containers npm run docker:down ``` ```bash # Remove locally built image npm run docker:image-rm ``` ```bash # All-in-one stop & remove image npm run docker:clean ``` -------------------------------- ### Create a New Feature Branch Source: https://github.com/adavesik/compoviz/blob/main/README.md Start a new branch for developing a specific feature. ```git git checkout -b feature/AmazingFeature ``` -------------------------------- ### Build Production Bundle Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Create a production-ready build of the application. ```bash npm run build ``` -------------------------------- ### Preview Production Build Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Serve the production build locally for previewing. ```bash npm run preview ``` -------------------------------- ### Build and Run Compoviz from Source Source: https://github.com/adavesik/compoviz/blob/main/README.md Build a development Docker image from source and run it. This is useful for local development. ```bash git clone https://github.com/adavesik/compoviz.git && cd compoviz docker compose up -d ``` ```bash docker build -t compoviz-dev . docker run -d -p 8080:80 --name compoviz-dev compoviz-dev ``` -------------------------------- ### Clone and Navigate Repository Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Clone your fork of the Compoviz repository and change into the project directory. ```bash git clone https://github.com/YOUR_USERNAME/compoviz.git cd compoviz ``` -------------------------------- ### Run Compoviz with Docker Source: https://github.com/adavesik/compoviz/blob/main/README.md Deploy Compoviz using a pre-built Docker image. Access the application at http://localhost:8080. ```bash docker run -d -p 8080:80 ghcr.io/adavesik/compoviz:latest # Access at http://localhost:8080 ``` -------------------------------- ### Run All Tests Source: https://github.com/adavesik/compoviz/blob/main/README.md Execute all test cases for the project. ```bash npm test ``` -------------------------------- ### Run Interactive UI Tests Source: https://github.com/adavesik/compoviz/blob/main/README.md Launch an interactive user interface for running tests. ```bash npm run test:ui ``` -------------------------------- ### Run Docker Compose with Pre-built Image Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Manually run Docker Compose using a specific configuration file and a pre-built image. ```bash docker compose -f compose/docker-compose.yml up -d ``` -------------------------------- ### Run Tests Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Execute the test suite locally. Options include running all tests once, running in watch mode, or opening the Vitest UI. ```bash # Run all tests once npm test ``` ```bash # Run tests in watch mode npm run test:watch ``` ```bash # Open Vitest UI for a better experience npm run test:ui ``` -------------------------------- ### Deploy Compoviz with Docker Compose Source: https://github.com/adavesik/compoviz/blob/main/README.md Self-host Compoviz using Docker Compose. This method does not require Node.js. ```bash # Create project directory mkdir compoviz && cd compoviz # Download compose file wget https://raw.githubusercontent.com/adavesik/compoviz/refs/heads/main/compose/docker-compose.yml # Deploy docker compose up -d # Access at http://localhost:8080 ``` -------------------------------- ### Lint Codebase Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Run ESLint to check for code style and potential errors. ```bash npm run lint ``` -------------------------------- ### Compoviz Project Structure Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Overview of the main directories within the Compoviz project. This helps contributors understand where to place new code. ```tree src/ ├── components/ # React components ├── hooks/ # Custom React hooks ├── utils/ # Utility functions └── styles/ # CSS files ``` -------------------------------- ### Run Tests in Watch Mode Source: https://github.com/adavesik/compoviz/blob/main/README.md Continuously run tests as code changes are made. ```bash npm run test:watch ``` -------------------------------- ### Create a Feature Branch Source: https://github.com/adavesik/compoviz/blob/main/CONTRIBUTING.md Before making changes, create a new branch for your feature. This helps organize contributions. ```git git checkout -b feature/your-feature-name ``` -------------------------------- ### Commit Changes with Conventional Commits Source: https://github.com/adavesik/compoviz/blob/main/README.md Commit code changes following the Conventional Commits specification. ```git git commit -m 'feat: add AmazingFeature' ``` -------------------------------- ### Push Changes to Remote Branch Source: https://github.com/adavesik/compoviz/blob/main/README.md Upload local commits to a specified remote branch. ```git git push origin feature/AmazingFeature ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.