Noqx

Extended logic puzzle solver of Noq.

Current Maintainers

• @T0nyX1ang: backend, frontend, bug fixes

• @zhuyaoyu: (huge) solver optimizations, bug fixes

Current development status

• Remove redundant codes and formatting codes.

• New solver backend with new UI design (See issue #2)

• Change the backend from Django to Starlette with Uvicorn (See issue #31, #50).

• Change the frontend from Noq native to penpa-edit. (See issue #36).

How to run locally

Use PDM with a virtual environment (Recommended)

• Install PDM first.

• Clone this project recursively and switch to master branch.

    git clone https://github.com/T0nyX1ang/noqx.git --recursive

• Install dependencies with PDM:

    pdm install

• Run with PDM:

    pdm run noqx.py

Use PIP

• Install requirements (automatically generated by PDM):

    pip install -r requirements.txt

• Clone this project recursively and switch to master branch.

    git clone https://github.com/T0nyX1ang/noqx.git --recursive

• Run locally (based on your system):

    py -3 noqx.py
    python3 noqx.py

Additional Usage

    usage: noqx.py [-h] [-H HOST] [-p PORT] [-d]

    optional arguments:
      -h, --help            show this help message and exit
      -H HOST, --host HOST  the host to run the server on.
      -p PORT, --port PORT  the port to run the server on.
      -d, --debug           whether to enable debug mode with auto-reloading.
      -tl TIME_LIMIT, --time_limit TIME_LIMIT
                            time limit in seconds (default = 30).

How to contribute

• Install PDM first.

• Clone this project recursively and switch to dev branch.

    git clone https://github.com/T0nyX1ang/noqx.git --recursive
    git checkout dev

• Install dependencies with PDM:

    pdm install -d

• Install pre-commit and add commit hooks:

    pre-commit install

• Free to PR now ^_^