From b34bbc889fbd6615746f7e62ee6c5e173401f7f8 Mon Sep 17 00:00:00 2001 From: Mike Clark Date: Sat, 15 Feb 2025 18:36:06 +0000 Subject: [PATCH 1/3] upating docs for people on a clean clone --- docs/actual-server-repo-move.md | 2 +- docs/contributing/project-details/index.md | 2 +- docs/install/local.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/actual-server-repo-move.md b/docs/actual-server-repo-move.md index e052784a..582bd9cb 100644 --- a/docs/actual-server-repo-move.md +++ b/docs/actual-server-repo-move.md @@ -35,7 +35,7 @@ The reasons for this change are as follows: ``` 3. Install the required dependencies for the server: ``` - yarn install:server + yarn workspaces focus actual-sync --production ``` 4. Run the server with: ``` diff --git a/docs/contributing/project-details/index.md b/docs/contributing/project-details/index.md index 384ad7a7..7cca3eb5 100644 --- a/docs/contributing/project-details/index.md +++ b/docs/contributing/project-details/index.md @@ -38,7 +38,7 @@ The shared underlying functionality component used by both the web/desktop front ## Sync Server -The Sync Server, also known as Actual Server, holds all of the code for the synchronization element of the Actual Budget application. Actual server has a dependency of Actual so when you pull Actual Server and deploy it to your hosting method of choice, be that Fly, Local etc. and run `yarn install:server` Actual will be downloaded as a dependency from NPM and installed into the Actual Server deployment. +The Sync Server, also known as Actual Server, holds all of the code for the synchronization element of the Actual Budget application. Actual server has a dependency of Actual so when you pull Actual Server and deploy it to your hosting method of choice, be that Fly, Local etc. and run `yarn workspaces focus actual-sync --production` Actual will be downloaded as a dependency from NPM and installed into the Actual Server deployment. You can see this in the [package.json](https://github.com/actualbudget/actual/blob/master/packages/sync-server/package.json) file; diff --git a/docs/install/local.md b/docs/install/local.md index 621b9e18..d1c130f2 100644 --- a/docs/install/local.md +++ b/docs/install/local.md @@ -29,7 +29,7 @@ Actual server is used for syncing changes across devices. It comes with the late ``` 3. Install all the required dependencies using yarn. ```bash - yarn install:server + yarn workspaces focus actual-sync --production ``` ## Running Actual @@ -91,7 +91,7 @@ When accessing Actual for the first time, you may be prompted to provide a URL f 1. Stop the server if it’s running. You can use the keyboard shortcut CTRL-C (even on macOS) to stop the server or close the terminal window it’s running from. 2. Run `git pull` from the directory you cloned the project into. This will download the latest server code. -3. Run `yarn install` from that same directory. This will download the latest web client code, along with any updated dependencies for the server. +3. Run `yarn workspaces focus actual-sync --production` from that directory. This will download the latest web client code, along with any updated dependencies for the server. 4. Restart the server by running `yarn start`. Actual is constantly evolving to include new features and improve the user's experience. It is always recommended that your local installation be updated with our [latest releases](https://actualbudget.org/docs/releases). From 1c8945f69630166fff52dc63afcb8121904c9098 Mon Sep 17 00:00:00 2001 From: Mike Clark Date: Sun, 16 Feb 2025 16:34:10 +0000 Subject: [PATCH 2/3] assume we will do this --- docs/actual-server-repo-move.md | 2 +- docs/contributing/project-details/index.md | 2 +- docs/install/local.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/actual-server-repo-move.md b/docs/actual-server-repo-move.md index 582bd9cb..185900e1 100644 --- a/docs/actual-server-repo-move.md +++ b/docs/actual-server-repo-move.md @@ -35,7 +35,7 @@ The reasons for this change are as follows: ``` 3. Install the required dependencies for the server: ``` - yarn workspaces focus actual-sync --production + yarn workspaces focus @actual-app/sync-server --production ``` 4. Run the server with: ``` diff --git a/docs/contributing/project-details/index.md b/docs/contributing/project-details/index.md index 7cca3eb5..57585fe6 100644 --- a/docs/contributing/project-details/index.md +++ b/docs/contributing/project-details/index.md @@ -38,7 +38,7 @@ The shared underlying functionality component used by both the web/desktop front ## Sync Server -The Sync Server, also known as Actual Server, holds all of the code for the synchronization element of the Actual Budget application. Actual server has a dependency of Actual so when you pull Actual Server and deploy it to your hosting method of choice, be that Fly, Local etc. and run `yarn workspaces focus actual-sync --production` Actual will be downloaded as a dependency from NPM and installed into the Actual Server deployment. +The Sync Server, also known as Actual Server, holds all of the code for the synchronization element of the Actual Budget application. Actual server has a dependency of Actual so when you pull Actual Server and deploy it to your hosting method of choice, be that Fly, Local etc. and run `yarn workspaces focus @actual-app/sync-server --production` Actual will be downloaded as a dependency from NPM and installed into the Actual Server deployment. You can see this in the [package.json](https://github.com/actualbudget/actual/blob/master/packages/sync-server/package.json) file; diff --git a/docs/install/local.md b/docs/install/local.md index d1c130f2..ad249f2c 100644 --- a/docs/install/local.md +++ b/docs/install/local.md @@ -91,7 +91,7 @@ When accessing Actual for the first time, you may be prompted to provide a URL f 1. Stop the server if it’s running. You can use the keyboard shortcut CTRL-C (even on macOS) to stop the server or close the terminal window it’s running from. 2. Run `git pull` from the directory you cloned the project into. This will download the latest server code. -3. Run `yarn workspaces focus actual-sync --production` from that directory. This will download the latest web client code, along with any updated dependencies for the server. +3. Run `yarn workspaces focus @actual-app/sync-server --production` from that directory. This will download the latest web client code, along with any updated dependencies for the server. 4. Restart the server by running `yarn start`. Actual is constantly evolving to include new features and improve the user's experience. It is always recommended that your local installation be updated with our [latest releases](https://actualbudget.org/docs/releases). From 595a5367aa1a8250e77696d627b3d969cc7d9a9b Mon Sep 17 00:00:00 2001 From: Michael Clark <5285928+MikesGlitch@users.noreply.github.com> Date: Sun, 16 Feb 2025 22:42:52 +0000 Subject: [PATCH 3/3] Update local.md --- docs/install/local.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/local.md b/docs/install/local.md index ad249f2c..fc953e0a 100644 --- a/docs/install/local.md +++ b/docs/install/local.md @@ -29,7 +29,7 @@ Actual server is used for syncing changes across devices. It comes with the late ``` 3. Install all the required dependencies using yarn. ```bash - yarn workspaces focus actual-sync --production + yarn workspaces focus @actual-app/sync-server --production ``` ## Running Actual