Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (49 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

65 lines (49 loc) · 1.48 KB
Raw

Contributing to MulmoCast

Thank you for your interest in contributing to MulmoCast App! This guide will help you understand the project structure and development workflow.

Project Overview

MulmoCast is an Electron application with a React frontend and Express backend. The application provides a modern desktop interface for managing multimedia casting projects.

Technology Stack

  • Frontend: Vue 3, TypeScript, Tailwind CSS, shadcn/ui
  • Backend: Node.js
  • Desktop: Electron
  • Build Tool: Vite
  • Styling: Tailwind CSS with shadcn/ui components

Project Structure

mulmocast-app/
├── src/
│   ├── main/            # Backend Node.js
│   └── renderer/        # Frontend Vue application
│       ├── pages/       # Vue components
│       │   └── ui/      # shadcn/ui base components
│       ├── lib/         # Utilities and helpers
│       └── styles/      # CSS styles

Development Setup

  1. Install dependencies:

    yarn install

  2. Start development server:

    yarn start

  3. Run linting:

    yarn lint

  4. Format code:

    yarn format

Adding shadcn-vue Components

To add new shadcn-vue components to the project:

npx shadcn-vue@latest add [component-name]

For example:

npx shadcn-vue@latest add button
npx shadcn-vue@latest add card
npx shadcn-vue@latest add dialog