7aa55883e2
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Chores** - Refined repository settings to auto-exclude environment and build-related files. - Introduced a new configuration that streamlines local development and displays key tool versions on setup. - **Documentation** - Expanded contribution guidelines with a dedicated developer resources section linking to guides on development practices and repository structure. - Updated workflow instructions to better assist developers in setting up their environment, especially for those using Nix. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
3.5 KiB
Unraid API Development Workflows
This document outlines the various workflow styles available for developing, building, and deploying the Unraid API monorepo.
Repository Structure
The Unraid API monorepo consists of several packages:
api: The Unraid API backendweb: The web frontend componentsplugin: The Unraid pluginunraid-ui: UI components library
Development Workflows
Local Development
To start all development servers in the monorepo:
pnpm dev
This command runs all development servers concurrently:
- API server: http://localhost:3001
- Web components: http://localhost:4321
- UI components: http://localhost:5173
Package-Specific Development
If you want to work on a specific package, you can run its development server individually:
API Development
cd api
pnpm dev
Web Development
cd web
pnpm dev
UI Component Development
cd unraid-ui
pnpm dev
Building Workflows
Building All Packages
To build all packages in the monorepo:
pnpm build
Watch Mode Building
For continuous building during development:
pnpm build:watch
This is useful when you want to see your changes reflected without manually rebuilding. This will also allow you to install a local plugin to test your changes.
Package-Specific Building
API Building
cd api
pnpm build
Web Building
cd web
pnpm build
Development Build for Web
cd web
pnpm build:dev
Deployment Workflows
Deploying to Development Unraid Server
To deploy to a development Unraid server:
pnpm unraid:deploy <SERVER_IP>
This command builds and deploys all components to the specified Unraid server.
Package-Specific Deployment
API Deployment
cd api
pnpm unraid:deploy <SERVER_IP>
Web Deployment
cd web
pnpm unraid:deploy <SERVER_IP>
Plugin Deployment
cd plugin
pnpm unraid:deploy <SERVER_IP>
Testing
To run tests across all packages:
pnpm test
Package-Specific Testing
cd <package-directory>
pnpm test
Code Quality Workflows
Linting
To lint all packages:
pnpm lint
To automatically fix linting issues:
pnpm lint:fix
Type Checking
To run type checking across all packages:
pnpm type-check
GraphQL Codegen Workflows
For packages that use GraphQL, you can generate types from your schema:
cd <package-directory>
pnpm codegen
To watch for changes and regenerate types:
cd <package-directory>
pnpm codegen:watch
Docker Workflows
The API package supports Docker-based development:
cd api
pnpm container:build # Build the Docker container
pnpm container:start # Start the container
pnpm container:stop # Stop the container
pnpm container:enter # Enter the container shell
pnpm container:test # Run tests in the container
CLI Commands
When working with a deployed Unraid API, you can use the CLI:
unraid-api --help
Recommended Workflow for New Developers
- Clone the repository:
git clone git@github.com:unraid/api.git - Set up the monorepo:
just setuporpnpm install - Start development servers:
pnpm dev - Make your changes
- Test your changes:
pnpm test - Deploy to a development server:
pnpm unraid:deploy <SERVER_IP> - Verify your changes on the Unraid server
If using nix, run nix develop from the root of the repo before Step 2.