datumforge / datum

Datum's central server
https://datum.net
Apache License 2.0
53 stars 7 forks source link

[Doc Request] Getting started documentation #1072

Closed adelowo closed 1 week ago

adelowo commented 1 week ago

Hi all,

Interesting project, I took a Quick Look at the repo yesterday and tried to set it up locally to probably work on an issue or see how I can be helpful in my free time but I couldn't seem to get it working.

I had limited time to take a look but I suppose I should be able to get it up and running over the weekend when I have more free time but it'd be great if there was a getting started guide.

task install && task generate

seems to error out

CleanShot 2024-06-28 at 16 11 57

matoszz commented 1 week ago

hey @adelowo thanks for your comment / request; you're totally right, we're a bit sparse on the local setup guide. I was actually just looking at a project called Hermit https://github.com/cashapp/hermit that seemed like maybe a good way to get our local dependencies bookstrapped into the repo. It appears there's also an un-related error from the local setup from your screen shot around possibly an upstream openFGA change so @golanglemonade is going to look at that as well. Appreciate any support / help you're willing to provide!

adelowo commented 1 week ago

hey @adelowo thanks for your comment / request; you're totally right, we're a bit sparse on the local setup guide. I was actually just looking at a project called Hermit https://github.com/cashapp/hermit that seemed like maybe a good way to get our local dependencies bookstrapped into the repo. It appears there's also an un-related error from the local setup from your screen shot around possibly an upstream openFGA change so @golanglemonade is going to look at that as well. Appreciate any support / help you're willing to provide!

thanks! Will checkout hermit

matoszz commented 1 week ago

I'm drafting a PR now with more documentation / instructions / setup guides so that should be incoming shortly!

golanglemonade commented 1 week ago

@adelowo The latest release should resolve the error you were seeing with task generate. Thanks for reporting it!

adelowo commented 1 week ago

@adelowo The latest release should resolve the error you were seeing with task generate. Thanks for reporting it!

works perfectly. thanks!