Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upating Local install docs for people on a clean clone #645

Merged
merged 3 commits into from
Feb 17, 2025
+4 −4
Merged

Upating Local install docs for people on a clean clone #645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b34bbc8
upating docs for people on a clean clone
MikesGlitch Feb 15, 2025
1c8945f
assume we will do this
MikesGlitch Feb 16, 2025
595a536
Update local.md
MikesGlitch Feb 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/actual-server-repo-move.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-app/sync-server --production
```
4. Run the server with:
```
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/project-details/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-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;

Expand Down
4 changes: 2 additions & 2 deletions docs/install/local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-app/sync-server --production
```

## Running Actual
Expand Down Expand Up @@ -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 <kbd>CTRL-C</kbd> (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-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).
Expand Down
Loading