demystify-web 0.1.5

A web front end to demystify, a constraint solving tool for explaining puzzles
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# demystify-web

`demystify-web` is the web interface for the `demystify` constraint satisfaction problem solver. It aims to provide an easy-to-use browser interface for solving and understanding puzzles through detailed, human-readable explanations.

## Overview

This package offers a web-based frontend to the core `demystify` solver. If you want low-level access to the solving engine, use the main [`demystify`](https://github.com/stacs-cp/demystify-rs) package instead.

## Installation

### Prerequisites

* A reasonably recent version of `rust`. Install with [rustup](https://rustup.rs/)
* If you're on **Windows**, you'll need LLVM: `winget install LLVM.LLVM`

The web interface will automatically handle the installation of `conjure` (via Docker/Podman if needed) when you run it.

### Setup

1. Clone the repository:
   ```sh
   git clone https://github.com/stacs-cp/demystify-rs
   cd demystify-rs
   ```

## Running the Web Interface

To start the web server:

```sh
cargo run --release --bin demystify-web
```

Then navigate to the URL displayed in your terminal (typically `http://localhost:8008`).

## Testing

To verify that everything is working correctly:

```sh
cargo test --workspace
```

Note: The first test run may take longer if Docker/Podman needs to download the Conjure image.

## Development Status

`demystify-web` is under active development. Some features may be incomplete or subject to change.

## Contributing

Contributions are welcome. Feel free to open issues and submit pull requests on the [GitHub repository](https://github.com/stacs-cp/demystify-rs).

## License

Licensed under the MPL 2.0 License. See the `LICENSE.txt` file for details.