A local-first personal finance app
Updating references to Actual-Server to point to Actual repository (#620)
Michael Clarka0a0d5de514a
diff --git a/docs/advanced/bank-sync/gocardless.md b/docs/advanced/bank-sync/gocardless.mdindex 499afba096..6c26867e61 100644--- a/docs/advanced/bank-sync/gocardless.md+++ b/docs/advanced/bank-sync/gocardless.md@@ -117,13 +117,13 @@ If your bank limits the amount of historical data you can fetch, you need to addTo achieve this:-1. Read the instructions about integrating with GoCardless: https://github.com/actualbudget/actual-server/blob/master/src/app-gocardless/README.md+1. Read the instructions about integrating with GoCardless: https://github.com/actualbudget/actual/blob/master/packages/sync-server/src/app-gocardless/README.md2. Toward the top is a link to the Google Docs containing data points for the GoCardless integration. Locate your bank's ID in the document.-3. Fork the Actual server repository: https://github.com/actualbudget/actual-server/fork-4. Edit the file `src/app-gocardless/bank-factory.js`.+3. Fork the Actual repository: https://github.com/actualbudget/actual/fork+4. Edit the file `packages/sync-server/src/app-gocardless/bank-factory.js`.5. Add your bank's ID (from the Google Docs) to the `BANKS_WITH_LIMITED_HISTORY` list.6. Commit your changes and push to your fork.-7. Create a pull request to the main Actual server repository.+7. Create a pull request to the main Actual repository.8. Add a release note in `upcoming-release-notes/` describing your change (see [writing good release notes](/docs/contributing/#writing-good-release-notes)).9. Commit your changes and push to your fork.diff --git a/docs/contributing/project-details/index.md b/docs/contributing/project-details/index.mdindex c2f495a1d7..384ad7a752 100644--- a/docs/contributing/project-details/index.md+++ b/docs/contributing/project-details/index.md@@ -4,8 +4,7 @@ Actual is made up of lots of different _packages_. This article covers how theyAll of the repositories can be found in the [Actual Budget](https://github.com/actualbudget) organization on GitHub, within that organization you will then find the following repositories-- [Actual](https://github.com/actualbudget/actual)-- [Actual Server](https://github.com/actualbudget/actual-server)+- [Actual & Actual Server](https://github.com/actualbudget/actual)- [docs](https://github.com/actualbudget/docs)## Actual@@ -20,7 +19,7 @@ This repository holds all of the front end code for the Actual Budget applicatio└── desktop-client└── desktop-electron└── loot-core- └── node-libofx+ └── sync-server...│```@@ -37,13 +36,11 @@ This is the source code for the Desktop application, in its current state it isThe shared underlying functionality component used by both the web/desktop frontend and the in-browser database server.-### Node Libofx+## Sync Server-## Actual 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.-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` 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-server/blob/master/package.json) file;+You can see this in the [package.json](https://github.com/actualbudget/actual/blob/master/packages/sync-server/package.json) file;```json"dependencies": {diff --git a/docs/contributing/releasing.md b/docs/contributing/releasing.mdindex 71b1e37172..3bf7dcf590 100644--- a/docs/contributing/releasing.md+++ b/docs/contributing/releasing.md@@ -23,7 +23,7 @@ For example:- `v23.4.0` - first release launched on 9th of April, 2023;## Setting up the PRs-Pull requests will need to be opened in all three repositories - [docs](https://github.com/actualbudget/docs), [actual](https://github.com/actualbudget/actual) and [actual-server](https://github.com/actualbudget/actual-server).+Pull requests will need to be opened in all two repositories - [docs](https://github.com/actualbudget/docs), [actual](https://github.com/actualbudget/actual).Make sure to name the branch `release/X.Y.Z` where `X.Y.Z` is the version number. This will trigger the release notes tooling, which will comment on your PR with the generated release notes. You can then copy-paste the release notes into the `Release-Notes.md` file in the `docs ` repository.@@ -34,22 +34,12 @@ This automation will also delete all the outdated release note files from the `u- `packages/api/package.json`- `packages/desktop-client/package.json`- `packages/desktop-electron/package.json`+ - `packages/sync-server/package.json`2. Open the pull request, the release notes workflow will run and collate the release notes into a comment in the PR.3. The PR can now be marked as ready for review.-### actual-server-1. Bump the version in `package.json`-2. Open the pull request, the release notes workflow will run and collate the release notes into a comment in the PR.-3. The PR can not be finalized until the web package has been released as it uses the new version as a dependency.--Once the `actual` PR has been approved and the new web package has been [published to NPM](#building-and-releasing), the server PR can be finalized.-1. Bump the web dependency version in `package.json`-2. Run `yarn install`-3. Push the updated `package.json` and `yarn.lock`-4. The PR can now be marked as ready for review.-### docs-After the release notes workflows in the actual and actual-server PRs have been run, copy the collated notes into a new blog post using a previous release as a template. The release notes will also need adding to the `docs/releases.md` file.+After the release notes workflows in the actual PR has been run, copy the collated notes into a new blog post using a previous release as a template. The release notes will also need adding to the `docs/releases.md` file.## Building and Publishing to NPMOnce the web PR has been approved, the new version of the API and web packages need to be published to NPM. If you haven't done this before, another maintainer will need to give you access.@@ -90,7 +80,7 @@ yarn npm publish --access public## GitHub Tags and Releases-Once the web and server releases have been merged, they need to be tagged. When the tag is pushed to `actual-server` it will trigger the Docker stable image to be built and published.+Once the release has been merged, it need to be tagged. When the tag is pushed to `actual` it will trigger the Docker stable image to be built and published.Run the below in each repository, or use the GitHub UI.```bash@@ -145,6 +135,6 @@ During the "Certification" stage the app is checked by Microsoft to ensure quali## Announcement-After the release is out on `actual-server` - remember to deploy it and do a quick smoke test to verify things still work as expected. If they do: continue with sending an announcement on Discord and Twitter.+After the release is out on `actual` - remember to deploy it and do a quick smoke test to verify things still work as expected. If they do: continue with sending an announcement on Discord and Twitter.:tada:diff --git a/docs/install/docker.md b/docs/install/docker.mdindex 6f1af15557..8b213e3d9e 100644--- a/docs/install/docker.md+++ b/docs/install/docker.md@@ -29,7 +29,7 @@ The `edge` tag is updated every time a commit is pushed to the `master` branch.Pre-requisites: Docker-You can use the [`docker-compose.yml` file included in the `actual-server` repository](https://github.com/actualbudget/actual-server/blob/master/docker-compose.yml) to run the latest stable version of the server.+You can use the [`docker-compose.yml` file included in the `actual` repository](https://github.com/actualbudget/actual/blob/master/packages/sync-server/docker-compose.yml) to run the latest stable version of the server.To create and run the container:diff --git a/docs/install/local.md b/docs/install/local.mdindex ab9ec623b9..d61cd58125 100644--- a/docs/install/local.md+++ b/docs/install/local.md@@ -1,6 +1,6 @@# Local Installation-The easiest way to get Actual running locally is to use [actual-server](https://github.com/actualbudget/actual-server).+The easiest way to get Actual running locally is to use [actual-server](https://github.com/actualbudget/actual/tree/master/packages/sync-server).Actual server is used for syncing changes across devices. It comes with the latest version of the [Actual web client](https://github.com/actualbudget/actual).@@ -18,25 +18,25 @@ Actual server is used for syncing changes across devices. It comes with the late## Installing Actual-1. After the prerequisites are fulfilled, clone the [Actual server](https://github.com/actualbudget/actual-server) project in your project root directory where you want to install Actual.+1. After the prerequisites are fulfilled, clone the [Actual](https://github.com/actualbudget/actual) project in your project root directory where you want to install Actual.```bash- git clone https://github.com/actualbudget/actual-server.git+ git clone https://github.com/actualbudget/actual.git```-2. Navigate to the Actual Server in your project root director.+2. Navigate to the Actual in your project root director.```bash- cd actual-server+ cd actual```3. Install all the required dependencies using yarn.```bash- yarn install+ yarn install:server```## Running Actual-After the Actual server is installed, start the Actual server by running the following command:+After the Actual is installed, start the Actual server by running the following command:```bash-yarn start+yarn start:server```Note that if you restart your computer, you’ll have to run this command again to start the server.@@ -50,7 +50,7 @@ After=network.target[Service]WorkingDirectory=[Link to your actual-server install directory, ex. /var/www/html/actual]-ExecStart=/usr/bin/yarn start+ExecStart=/usr/bin/yarn start:serverRestart=on-watchdog[Install]@@ -71,7 +71,7 @@ root@server:/etc/systemd/system# systemctl status actual-serverCGroup: /system.slice/actual-server.service├─842857 node /usr/bin/yarn start├─842870 /usr/bin/node /var/www/html/actual-server/.yarn/releases/yarn->- └─842881 /usr/bin/node app+ └─842881 /usr/bin/node app```5. You should see output similar to below. The main thing to check for is the "Active: active (running)" section. From here you can consider [Setting up a Reverse Proxy](https://actualbudget.org/docs/config/reverse-proxies) and [Activating HTTPS](https://actualbudget.org/docs/config/https)6. To stop / start / restart the server use the commands@@ -80,7 +80,7 @@ root@server:/etc/systemd/system# systemctl status actual-server- ```systemctl restart actual-server```7. To see the system log showing status or errors use the command from before. This can be helpful for troubleshooting.- ```systemctl status actual-server```-+## Accessing ActualAfter the server has been started, you can access Actual using your browser at [http://localhost:5006](http://localhost:5006).