search

Synphonyte / leptos-struct-table

Easily create Leptos table components from structs
Apache License 2.0
164 stars 24 forks source link

Expand on usage of examples #52

Closed luckynumberke7in closed 2 months ago

luckynumberke7in commented 2 months ago

Created a simple README.md to show the steps for how someone can successfully run the examples.

luckynumberke7in commented 2 months ago

I had a bit of a hiccup getting this to work due to the path of this package in Cargo.toml and figured maybe I could help someone else dodge my pain =)

I'm unsure of other ways (maybe an even easier way to get these examples running)?

Please feel free to let me know if there are better ways!

maccesch commented 2 months ago

Thanks for trying to improve the docs!

However there is a readme in every example folder that describes how to run it. It is indeed different for different examples. The sqlx one uses cargo-leptos but most simply use trunk.

luckynumberke7in commented 2 months ago

Should I move this PR inside that specific example? I read the README.md inside the example serverfn_sqlx also using cargo leptos watch but the information inside there didn't actually help me, personally.

luckynumberke7in commented 2 months ago

I ran into a strange situation where I was receiving error messages that made it seem like $PATH wasn't set up for Rust correctly on my new system which derailed me by more time than I'd like to admit...

I can only imagine there will be others on the more beginner end of Rust running into these same issues.

luckynumberke7in commented 2 months ago

Specifically, I was getting errors about reading the Cargo.toml file because you have the dependency set to leptos-struct-table = { path = "../.." } and I originally grabbed the example separately from the repo and missed this.

Definitely a skill issue... so maybe not your responsibility, but if I can help others avoid experiencing my rabbit hole last night, I'd be happy lol.

maccesch commented 2 months ago

Sure. We can add a sentence to each example readme that you need to make sure to have the whole repo checked out.

luckynumberke7in commented 2 months ago

Let me know what you think! I removed the 1st README.md and updated the examples. I also added a touch of styling to the markdown.

maccesch commented 2 months ago

Thank you very much!