Skip to content

Modern Docker Management, Designed for Everyone

chore: update repo resources

Kyle Mendell7e58de2d4b57
diff --git a/.github/assets/arcane-ss.jpeg b/.github/assets/arcane-ss.jpeg
new file mode 100644
index 000000000..695db86d6
Binary files /dev/null and b/.github/assets/arcane-ss.jpeg differ
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index aea2d3270..2d7f330a7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,63 +1,85 @@
# Contributing to Arcane
-Thank you for your interest in contributing to Arcane! We welcome contributions from the community to help make Arcane better. Whether it's reporting a bug, suggesting a feature, or writing code, your help is appreciated.
+Thanks for helping make Arcane better! Contributions of all kinds are welcome.
## Ways to Contribute
-- **Reporting Bugs:** If you encounter a bug, please help us by submitting a detailed bug report. Use the [**Bug Report**](https://github.com/ofkm/arcane/issues/new?template=bug.yml) template on GitHub.
-- **Suggesting Features:** Have an idea for a new feature or an enhancement? We'd love to hear it! Use the [**Feature Request**](https://github.com/ofkm/arcane/issues/new?template=feature.yml) template on GitHub.
-- **Code Contributions:** If you'd like to contribute code, please follow the process outlined below.
-- **Documentation:** Improvements to the documentation are always welcome.
-
-## Code Contribution Process
-
-1. **Fork the Repository:** Start by forking the main Arcane repository on GitHub.
-2. **Clone Your Fork:** Clone your forked repository to your local machine:
- ```bash
- git clone https://github.com/<your-username>/arcane.git
- cd 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
- # or
- git branch -m 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.
- ```bash
- npm install
- npm run dev
- ```
-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
- npm run lint
- npm 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.
- ```bash
- git add .
- git commit -m "feat: Add feature X"
- # or
- git commit -m "fix: Resolve issue Y"
- ```
-8. **Keep Your Branch Updated:** Periodically update your branch with the latest changes from the upstream repository:
- ```bash
- git fetch upstream
- git rebase upstream/main
- ```
-9. **Push Your Branch:** Push your changes to your forked repository:
- ```bash
- git 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.
- - 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.
+- Reporting bugs: use the GitHub templates — Bug Report and Feature Request.
+- Suggesting features or improvements.
+- Code contributions (frontend or backend).
+
+## Quick Start
+
+Prereqs:
+
+- Go 1.25 and Docker
+- Node 24 and pnpm 10.15
+
+1. Fork and clone:
+
+ ```bash
+ git clone https://github.com/<your-username>/arcane.git
+ cd arcane
+ ```
+
+2. Create a branch:
+
+ ```bash
+ git switch -c feat/my-new-feature
+ # or
+ git switch -c fix/issue-123
+ ```
+
+3. Frontend (SvelteKit):
+
+ ```bash
+ cd frontend
+ pnpm install
+ pnpm dev
+ ```
+
+4. Backend (Go + Gin):
+
+ ```bash
+ go install github.com/air-verse/air@latest
+ cd backend
+ air
+ ```
## 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.
+- Conventional Commits for messages:
+
+ ```bash
+ git add .
+ git commit -m "feat: add X"
+ # or
+ git commit -m "fix: resolve Y"
+ ```
+
+- Frontend lint/format:
+
+ ```bash
+ cd frontend
+ pnpm check
+ pnpm format
+ ```
+
+- Backend basics:
+
+ ```bash
+ cd backend
+ go fmt ./...
+ go vet ./...
+ ```
+
+## Pull Requests
+
+- Keep changes focused and small when possible.
+- Include context in the PR description and link issues (e.g., “Closes #123”).
+- Be ready to iterate based on review feedback.
+
+## Issues & Feedback
-Thank you again for contributing to Arcane!
+- Bug Report: https://github.com/ofkm/arcane/issues/new?template=bug.yml
+- Feature Request: https://github.com/ofkm/arcane/issues/new?template=feature.yml
diff --git a/README.md b/README.md
index e9c4d6def..d1a1bedbe 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,11 @@
<img src=".github/assets/arcane.svg" alt="Arcane Logo" width="300" height="300"/>
</p>
-Arcane is a modern, web-based interface for managing your Docker environment, built with SvelteKit. It offers a clean, intuitive overview and powerful management tools for your containers, images, volumes, and networks—all in one place.
+Arcane is a modern easy to use way to manage your docker containers, images, volumes, and networks — all in one place.
---
-<img width="1685" alt="image" src="https://github.com/user-attachments/assets/9d081a4f-4f4f-4d96-b196-d25faf788285" />
+<img width="1685" alt="image" src=".github/assets/arcane-ss.jpeg" />
---
@@ -19,4 +19,10 @@ For setup instructions, configuration details, and development guides, visit the
---
+## Translating
+
+Help translate Arcane on Crowdin: https://crowdin.com/project/arcane-docker-management
+
+---
+
Thank you for checking out Arcane! Your feedback and contributions are always welcome.
diff --git a/docker-compose.agent.yml b/docker-compose.agent.yml
index 58ad8caf7..df9f20a87 100644
--- a/docker-compose.agent.yml
+++ b/docker-compose.agent.yml
@@ -1,22 +1,16 @@
services:
arcane-agent:
- build:
- context: .
- dockerfile: docker/Dockerfile-agent
- target: agent
- args:
- BUILD_TAGS: exclude_frontend
- image: arcane-agent:dev
+ image: ghcr.io/ofkm/arcane-headless:1.0-preview
container_name: arcane-agent
ports:
- '3553:3553'
environment:
- AGENT_MODE=true
- - AGENT_BOOTSTRAP_TOKEN=this-is-my-test-bs-token
+ - AGENT_BOOTSTRAP_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxx
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- agent-data:/app/data
restart: unless-stopped
volumes:
- agent-data: {}
+ agent-data: