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.

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

Conversation

MikesGlitch
Copy link
Contributor

@MikesGlitch MikesGlitch commented Feb 15, 2025

Issue reported here: actualbudget/actual#4377

https://deploy-preview-645.www.actualbudget.org/docs/install/local

It turns out that yarn doesn't let you run scripts without first installing dependencies, so users will have to type it in the install manually.

The other alternative is to run the script with npm but that would add confusion.

I think yarn workspace focus is the best option to pick but here was the options:

  • Instruct users to yarn install (which would install all deps) - 1.07GB
  • Instruct users to yarn workspaces focus @actual-app/sync-server --production (which is a long command) - 60.6MB
  • Create a new shell script to run the command ./install-server.sh

In future we might want to consider packaging the server up into an executable. That way the user wont have to install node/deal with any of this stuff.

Here's an example packager - i've never used it: https://github.com/nexe/nexe

Copy link

netlify bot commented Feb 15, 2025

Deploy Preview for actualbudget-website ready!

Name Link
🔨 Latest commit 595a536
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget-website/deploys/67b269ee188dd40007f25b78
😎 Deploy Preview https://deploy-preview-645.www.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@MikesGlitch MikesGlitch marked this pull request as ready for review February 15, 2025 18:51
@actual-github-bot actual-github-bot bot added 🔍 Ready for review Someone needs to look into this. and removed 🚧 WIP labels Feb 15, 2025
@MikesGlitch MikesGlitch marked this pull request as draft February 15, 2025 19:50
@actual-github-bot actual-github-bot bot added 🚧 WIP and removed 🔍 Ready for review Someone needs to look into this. labels Feb 15, 2025
@MikesGlitch MikesGlitch marked this pull request as ready for review February 16, 2025 22:39
@actual-github-bot actual-github-bot bot added 🔍 Ready for review Someone needs to look into this. and removed 🚧 WIP labels Feb 16, 2025
Copy link
Contributor

@matt-fidd matt-fidd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the best solution of the three, saves a fair chunk of data transfer and space.

@actual-github-bot actual-github-bot bot added ✅ Approved Used in conjunction with Merge at Release. This means that the PR has been approved but not merged. and removed 🔍 Ready for review Someone needs to look into this. labels Feb 16, 2025
@MikesGlitch MikesGlitch merged commit ba49c16 into master Feb 17, 2025
10 checks passed
@MikesGlitch MikesGlitch deleted the docs-server-install-fix branch February 17, 2025 09:15
@actual-github-bot actual-github-bot bot added ✨ Merged and removed ✅ Approved Used in conjunction with Merge at Release. This means that the PR has been approved but not merged. labels Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants