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

docs: add setup instructions to README.md #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tomalexhughes
Copy link

What?

Adds setup instructions to run the project locally to README.md.

Why?

I wanted to contribute to the project but struggled to get the app working locally.

Copy link

netlify bot commented Jul 21, 2024

‼️ Deploy request for gloogle-gleam rejected.

Name Link
🔨 Latest commit 6fcfbf9

@tomalexhughes
Copy link
Author

@ghivert Please let me know if there's anything incorrect here. I was able to get the app running locally with these instructions, but I'm unsure if I've missed any short-cuts.

I do have an issue where the app crashes when syncing with Hex. I'll create a separate issue for this, unless there's something I'm missing as part of the setup?

@tomalexhughes tomalexhughes marked this pull request as ready for review July 21, 2024 17:55
@ghivert
Copy link
Owner

ghivert commented Jul 21, 2024

Hi! Thanks for the PR! I'll take a look at it! I'll try to simplify the setup as much as possible.
Meanwhile, be careful to properly cache (normally Gloogle does it by default) the hex packages, otherwise it will break hex stats ha ha (I already did it in the past 😅)

@tomalexhughes
Copy link
Author

Looks like I'm missing docs on the following env vars:

  • BUCKET_URI
  • SCALEWAY_ACCESS_KEY
  • SCALEWAY_SECRET_KEY

Feel free to push changes to this PR if I don't get to it first :)

@ghivert
Copy link
Owner

ghivert commented Jul 23, 2024

Congrats, you discovered a hidden feature of Gloogle: it saves the entirety of Gleam packages on an S3 bucket, in order to avoid querying too much Hex and breaking the stats (like, querying 1000 times Hex breaks statistics) 😁

I'll take some time to properly work on the README, and to provide an easy way to get started with Gloogle codebase asap (i.e. when I have some time outside of my job)

@ghivert
Copy link
Owner

ghivert commented Aug 1, 2024

Hey! I promise I did not forget you! It's just that time flies really quickly! Now that a rewrite of the search engine is done, I'll take some time to improving the setup of the project. So if you want to contribute in the future, it will not block you! Meanwhile, if you still want to continue on your own, feel free to ping me at any time. 🙂

@ghivert
Copy link
Owner

ghivert commented Aug 2, 2024

I made some changes, to simplify getting started on the project. S3 keys are not required anymore (because they're mainly optimisation).

Otherwise your README is fine, unless now, things have changed a little, and yarn should be use with corepack enable. Do you think you could update it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants