/pasteofexile

Paste of Exile - Path of Building Pastebin

Primary LanguageRustGNU General Public License v3.0GPL-3.0

Paste of Exile

Build Status License

pobb.in, a pastebin for Path Of Building builds.

pobb.in

Development

Required dependencies:

  • Node 16.7+
  • Yarn
  • Rust 1.52+ (including wasm toolchain: rustup target add wasm32-unknown-unknown)
  • wrangler: cargo install wrangler
  • TrunkRS: cargo install trunk
  • worker-build: cargo install worker-build
  • wasm-pack: cargo install wasm-pack

The application can be started with:

$ yarn start

To just build the application:

$ ./build.sh --dev
$ ./build.sh --release

Docker

Alternatively you can use docker to setup your build environment:

$ docker build -t pasteofexile .
$ docker run --rm -it \
    -v "$(pwd):/pasteofexile" \
    -p 8787:8787 \
    -u "$(id -u):$(id -g)" \
    pasteofexile \
    yarn start

Code Style

Rust code is formatted with cargo fmt and linted with cargo +nightly clippy --all-features -- -D warnings.

Commits are prefixed with their scope:

  • poe: if it is relevant for the entire project
  • app: if it is mainly a frontend change
  • worker: if it is mainly a backend/worker change
  • pob: if it is a data parsing change in the pob crate

Contributing

Contributions are always welcome, code, design ideas, mockups etc.

When contributing please try to follow coding conventions (cargo fmt, cargo clippy), code style and commit formatting.

Before working on big features please open an issue first or reach out, in case this feature is currently out of scope or already being worked on.