Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 2.21 KB

README.md

File metadata and controls

77 lines (50 loc) · 2.21 KB
Raw

Paste of Exile

Build Status License

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

pobb.in

Development

Required dependencies:

  • Node 16.7+
  • Yarn
  • Latest Rust (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

Code

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

Commits are prefixed with their scope/crate:

  • poe: relevant for the entire project
  • app: the frontend
  • pob: pob parsing and tools
  • poe-tree: poe tree parsing and processing
  • shared: mainly types shared between app and worker
  • snapshot: just a cli tool to generate stats
  • worker: the backend

Public API

For third-party integrations there are currently two public URLs to retrieve a build:

  • /:id/raw
  • /u/:username/:id/raw

Please always include a User-Agent which identifies your application and includes contact info, e.g.: User-Agent: app-name/version hosted.domain (contact: foo@bar, discord#0000).

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/discussion first or reach out (e.g. #tooldev-general on the official discord), in case this feature is currently out of scope or already being worked on.