"Getting Started" documentation is missing

[denispeplin]

The app seems a nice showcase for Perseus framework, but it's missing any "getting started" information, such as Rust and Perseus versions, and what commands are to run (I suppose it's perseus serve).

[seanpmyers]

Hey Denis,

I'll update the documentation with some better "getting started" content.

Overall the front-end is currently under heavy development/changing a lot, so I think I might need some more time before it is a good showcase for Perseus.

So currently this application contains a back-end and a front-end, with only the front-end utilizing perseus and sycamore.

The front-end is located under: ./application/frontend and if you just want to run the front-end with perseus the command should be in that folder's README but it is perseus serve -w. That will use perseus to compile and serve the content.

It may not work though without installing some additional software depending on your host OS. I did not document what I installed when getting it setup so the perseus documentation might be better for that.

The version of perseus I'm currently using is 0.3.6, I think I'll just point to the cargo.toml in the readme though as that is the source of truth for what Rust crates/versions are being used. Both the front-end and back-end have a cargo.toml by the way.

I also just use the latest version of Rust, I will double check but inside the cargo.toml there is an edition field which is currently 2021. Pretty sure that is supposed to tell you what versions of Rust are compatible but I'm honestly not sure.

The front-end is currently undergoing a lot of change as I tinker with it, the current main code's styling is using bootstrap which you would have to download. In the branch I'm currently developing on I removed bootstrap and I'm working on custom styles but haven't fixed a lot of stuff.

But yeah I'll see if I can update my READMEs to convey some of this better.

[denispeplin]

The frontend is running fine with 0.3.6, cargo run in application directory emitted the following:

warning: `loremaster` (bin "loremaster") generated 7 warnings
    Finished dev [unoptimized + debuginfo] target(s) in 0.12s
     Running `target/debug/loremaster`
Error: environment variable not found

and refused to start.

So yeah, I'll wait for the instructions.