mirror of
https://github.com/actualbudget/actual.git
synced 2026-10-11 22:49:59 +00:00
[AI] Document Dev Container option in development-setup docs (#7729)
* [AI] Document Dev Container option in development-setup docs * [AI] Add release notes for #7729 * [AI] Update spell-check dictionary for Codespaces
This commit is contained in:
@@ -1,7 +1,7 @@
|
|||||||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
||||||
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
|
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
|
||||||
{
|
{
|
||||||
"name": "Actual development",
|
"name": "Actual Devcontainer",
|
||||||
"dockerComposeFile": ["../docker-compose.yml", "docker-compose.yml"],
|
"dockerComposeFile": ["../docker-compose.yml", "docker-compose.yml"],
|
||||||
// Alternatively:
|
// Alternatively:
|
||||||
// "image": "mcr.microsoft.com/devcontainers/typescript-node:0-16",
|
// "image": "mcr.microsoft.com/devcontainers/typescript-node:0-16",
|
||||||
|
|||||||
@@ -44,6 +44,7 @@ CLP
|
|||||||
CMCIFRPAXXX
|
CMCIFRPAXXX
|
||||||
COBADEFF
|
COBADEFF
|
||||||
CODEOWNERS
|
CODEOWNERS
|
||||||
|
Codespaces
|
||||||
COEP
|
COEP
|
||||||
commerzbank
|
commerzbank
|
||||||
Copiar
|
Copiar
|
||||||
|
|||||||
@@ -6,6 +6,10 @@ This guide will help you set up your development environment for contributing to
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
If you prefer not to install Node and Yarn locally, you can use the [Dev Container](#dev-container) or run [Docker Compose](#docker-compose) directly.
|
||||||
|
:::
|
||||||
|
|
||||||
Before you begin, ensure you have the following installed:
|
Before you begin, ensure you have the following installed:
|
||||||
|
|
||||||
- **Node.js**: Version 22 or greater. You can download it from the [Node.js website](https://nodejs.org/en/download) (we recommend the LTS version).
|
- **Node.js**: Version 22 or greater. You can download it from the [Node.js website](https://nodejs.org/en/download) (we recommend the LTS version).
|
||||||
@@ -39,6 +43,34 @@ Before you begin, ensure you have the following installed:
|
|||||||
yarn typecheck
|
yarn typecheck
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Dev Container
|
||||||
|
|
||||||
|
The repo includes a [`.devcontainer/`](https://github.com/actualbudget/actual/tree/master/.devcontainer) configuration that follows the [Dev Containers spec](https://containers.dev/). Any tool that supports the spec can use it — for example VS Code or Cursor (with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)), JetBrains IDEs (via Gateway), GitHub Codespaces, or the [`@devcontainers/cli`](https://github.com/devcontainers/cli).
|
||||||
|
|
||||||
|
In an editor that supports the spec, open the cloned repo and accept the **Reopen in Container** prompt (or run the equivalent command from your editor's command palette). The container will build, `yarn install` will run automatically via `postCreateCommand`, and you'll be dropped into a shell with the toolchain ready.
|
||||||
|
|
||||||
|
To start the dev server, open a terminal inside the container and run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn start
|
||||||
|
```
|
||||||
|
|
||||||
|
The dev server will be available at `http://localhost:3001/`. Most editors automatically forward the port from the container to your host.
|
||||||
|
|
||||||
|
## Docker Compose
|
||||||
|
|
||||||
|
For other editors, run from the repo root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up --build
|
||||||
|
```
|
||||||
|
|
||||||
|
This starts a container that runs `yarn start:browser` on port 3001. Open `http://localhost:3001/` in your browser.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
The container mounts your repo at `/app`. If you've already run `yarn install` on your host, the native modules (`better-sqlite3`, `bcrypt`, `electron`, `sharp`) will be compiled for your host OS and won't work inside the Linux container. Either delete `node_modules/` first and let the container reinstall, or run the dev container path above (which rebuilds them automatically).
|
||||||
|
:::
|
||||||
|
|
||||||
## Essential Development Commands
|
## Essential Development Commands
|
||||||
|
|
||||||
All commands should be run from the **root directory** of the repository. Never run yarn commands from child workspace directories.
|
All commands should be run from the **root directory** of the repository. Never run yarn commands from child workspace directories.
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
category: Maintenance
|
||||||
|
authors: [nikhilweee]
|
||||||
|
---
|
||||||
|
|
||||||
|
Document the Dev Container and Docker Compose options as alternatives to local Node and Yarn setup in the contributor development-setup guide.
|
||||||
Reference in New Issue
Block a user