Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
docs: update development docs
Kyle Mendella9e0037e616b
diff --git a/docs/docs/development/building.md b/docs/docs/development/building.mdindex a5fabb4c1..4fbc34158 100644--- a/docs/docs/development/building.md+++ b/docs/docs/development/building.md@@ -10,6 +10,7 @@ This guide explains how to build the Arcane application from its source code. Th## Prerequisites- Node.js: Version 22 or higher.+- Go: v1.24 or higher.- npm, yarn, pnpm, or bun: A Node.js package manager. Examples will use `npm`.- Git: Required to clone the repository.- Docker Engine: Required if you intend to build the Docker image, and test functionality locally.@@ -25,47 +26,21 @@ This guide explains how to build the Arcane application from its source code. Th```2. **Install Dependencies:**- Install the necessary project dependencies using your preferred package manager:+ Run the build script located in the root of the repo. This will build the frontend and embded it in the backend.```bash- npm install+ ./build.sh```-3. **Run the Development Server (Optional):**- To run Arcane in development mode with hot-reloading:-- ```bash- npm run dev- ```-- This will start a local development server, typically accessible at `http://localhost:3000` .--4. **Linting and Formatting:**+3. **Linting and Formatting:**Before building, you might want to check for code style issues:```bash+ cd frontendnpm run lintnpm run format```-5. **Create a Production Build:**- To build the optimized production version of Arcane:-- ```bash- npm run build- ```-- This command uses SvelteKit's build process (powered by Vite) and the `@sveltejs/adapter-node` adapter. The output will be placed in the `build/` directory by default. This directory contains the standalone Node.js server and static assets needed to run Arcane.--6. **Run the Production Build:**- After a successful build, you can run the production server:-- ```bash- node build/index.js- ```-- Arcane should now be running using the built artifacts, typically accessible at `http://localhost:3000` (or the port configured for the production environment).-## Building the Docker ImageThe repository includes a `Dockerfile` to containerize the application.@@ -74,15 +49,11 @@ The repository includes a `Dockerfile` to containerize the application.2. **Build the Image:** From the root of the project directory, run:```bash- docker build -t arcane-local .+ docker buildx build -tag arcane --platform linux/amd64,linux/arm64 .```- You can replace `arcane-local` with your preferred image tag.+ You can replace `arcane` with your preferred image tag.3. **Run the Docker Container:**See the [Quickstart](/docs/getting-started/quickstart) guide on how to run the docker container.--## Summary--This covers the essential steps for building and running Arcane from its source code, both as a standalone Node.js application and as a Docker image.diff --git a/docs/docs/development/contributing.md b/docs/docs/development/contributing.mdindex fd34f594f..0287ce13e 100644--- a/docs/docs/development/contributing.md+++ b/docs/docs/development/contributing.md@@ -17,52 +17,77 @@ Thank you for your interest in contributing to Arcane! We welcome contributions## Code Contribution Process1. **Fork the Repository:** Start by forking the main Arcane repository on GitHub.+2. **Clone Your Fork:** Clone your forked repository to your local machine:+```bashgit clone https://github.com/<your-username>/arcane.gitcd arcane```+3. **Create a Branch:** Create a new branch for your feature or bug fix. Use a descriptive name:+```bash- git branch -m feature/my-new-feature+ git checkout -b feature/my-new-feature# or- git branch -m fix/issue-123+ git checkout -b fix/issue-123```-4. **Set Up Development Environment:** Follow the instructions in the [**Building from Source**](./building.md) guide to install dependencies and ensure you can run the development server.++4. **Set Up Development Environment:** Follow the instructions in the [**Building from Source**](./building.md) guide to set up your development environment:+```bash- npm install- npm run dev+ ./build.sh```+5. **Make Changes:** Implement your feature or bug fix. Write clear, concise code.+6. **Lint and Format:** Ensure your code adheres to the project's style guidelines by running the linters and formatters:+```bash+ cd frontendnpm run lintnpm run format```- Fix any issues reported.-7. **Commit Changes:** Commit your changes with a clear and descriptive commit message. Consider using [Conventional Commits](https://www.conventionalcommits.org/) if applicable.++7. **Test Your Changes:** Test your changes thoroughly to ensure they work as expected and don't break existing functionality.++8. **Commit Changes:** Commit your changes with a clear and descriptive commit message. We use [Conventional Commits](https://www.conventionalcommits.org/):+```bashgit add .- git commit -m "feat: Add feature X"+ git commit -m "feat: add feature X"# or- git commit -m "fix: Resolve issue Y"+ git commit -m "fix: resolve issue Y"```-8. **Keep Your Branch Updated:** Periodically update your branch with the latest changes from the upstream repository:++9. **Keep Your Branch Updated:** Periodically update your branch with the latest changes from the upstream repository:+```bashgit fetch upstreamgit rebase upstream/main```-9. **Push Your Branch:** Push your changes to your forked repository:++10. **Push Your Branch:** Push your changes to your forked repository:+```bashgit push origin feature/my-new-feature```-10. **Open a Pull Request:** Go to the original Arcane repository on GitHub and open a Pull Request (PR) from your branch to the main branch of the upstream repository.++11. **Open a Pull Request:** Go to the original Arcane repository on GitHub and open a Pull Request (PR) from your branch to the main branch of the upstream repository.- Provide a clear title and description for your PR.- Reference any related issues (e.g., "Closes #123").- Be prepared to discuss your changes and make adjustments based on feedback.## Code Style-Arcane uses [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to enforce code style and consistency. Please run `npm run lint` and `npm run format` before committing your changes. Configuration files (`.eslint.config.js`, `.prettierrc`) are included in the repository.+Arcane uses [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to enforce code style and consistency. Please run `npm run lint` and `npm run format` in the frontend directory before committing your changes. Configuration files are included in the repository.++## Development Tips++- Use Svelte 5 syntax for all frontend files+- Follow the existing code patterns and conventions+- Keep commits focused and atomic+- Write meaningful commit messages+- Test your changes in both development and production builds-Thank you again for contributing to Arcane!+Thank you for contributing to Arcane!