Context

This Repository contains the Sourcecode for the Rolewiki Project, which is a Web App designed to allow users to store, edit and access Information such as Character Details and "Lore" regarding Roleplaying Projects such as DnD or Text-based Roleplay Methods.

Running the code locally

If you don't have cargo-leptos installed you can install it with

cargo install cargo-leptos --locked

Then run

cargo leptos watch

to run the web server on localhost:3000. This will recompile automatically when changes are detected to the code.

Installing Additional Tools

This project, using cargo-leptos uses latest Rust, cargo-generate, and sass. If you run into any trouble, you may need to install one or more of these tools.

1. rustup toolchain install latest - make sure you have Rust latest
2. rustup target add wasm32-unknown-unknown - add the ability to compile Rust to WebAssembly
3. cargo install cargo-generate - install cargo-generate binary (should be installed automatically in future)
4. npm install -g sass - install dart-sass (should be optional in future)
5. Run npm install in end2end subdirectory before test

Compiling for Release

cargo leptos build --release

Will generate the server binary in target/release and your site package in target/site

Testing the Project

cargo leptos end-to-end

cargo leptos end-to-end --release

Cargo-leptos uses Playwright as the end-to-end test tool. Tests are located in end2end/tests directory.

Executing a Server on a Remote Machine Without the Toolchain

After running a cargo leptos build --release the minimum files needed are:

1. The server binary located in target/server/release
2. The site directory and all files within located in target/site

Copy these files to your remote server. The directory structure should be:

rolewiki
site/

Set the following environment variables (updating for your project as needed):

export LEPTOS_OUTPUT_NAME="rolewiki"
export LEPTOS_SITE_ROOT="site"
export LEPTOS_SITE_PKG_DIR="pkg"
export LEPTOS_SITE_ADDR="0.0.0.0:3000"
export LEPTOS_RELOAD_PORT="3001"

Finally, run the server binary.

Documentation

The detailed project documentation is available at ./docs/documentation.md