expln/metamath-lamp

Metamath-lamp (Lite Assistant for Metamath Proofs) is a GUI-based proof assistant for creating formal mathematical proofs in Metamath that does not require installation (just run it directly using your web browser).

Lite Assistant for Metamath Proofs

This is the repository for metamath-lamp (Lite Assistant for Metamath Proofs). Metamath-lamp is a proof assistant for creating formal mathematical proofs in the Metamath system. Unlike most other Metamath proof systems (such as mmj2 or original metamath-exe), users can use this proof assistant without installing anything; you can simply run it directly using your web browser. It's written in ReScript (a robustly typed programming language that compiles to JavaScript) using the React user interface library and Material UI Components. It's licensed under the MIT license.

You can use this proof assistant now by going to the Metamath-lamp web site.

For more information, see the Metamath-lamp Guide.

Here's a short video demo (without sound).

Screenshot

Here's a simple screenshot of metamath-lamp in action.

Common actions

How to run locally:

1. Clone the source code

git clone https://github.com/expln/metamath-lamp.git

2. Navigate to the project's directory

cd metamath-lamp

3. Install npm dependencies

npm install

4. Compile ReScript code (local and from all npm dependencies) to JS code

npm run compile-with-deps

5. Assemble a worker script

npx webpack --config webworker.webpack.config.js

6. Copy the worker script from ./dist to ./public

Windows: copy /B /Y ".\dist\webworker-main.js" ".\public"

Mac/Linux: cp ./dist/webworker-main.js ./public

7. Finally, run the project locally

npm run start

How to run all unit tests

npm run compile-test-all-unit

How to run all integration tests

npm run compile-test-all-int

How to run a particular test

1. In package.json, update 'compile-test-single' script replacing put_test_name_here with required test name. For example:

replace: "compile-test-single": "rescript && mocha --timeout 10000000 -g \"'put_test_name_here'\" src/**/test/**/*.js",

with: "compile-test-single": "rescript && mocha --timeout 10000000 -g \"'finds proofs for simple wffs'\" src/**/test/**/*.js",

2. Run tests:

npm run compile-test-single

How to debug

There is no standard way to debug ReScript code. But ReScript gets compiled to readable JS code. So it is possible to debug JS code. In order to debug any use case:

1. Create a test which reproduces required use case or modify existing test.
2. Compile the code npm run compile
3. Use your favorite IDE to place a break point in generated JS code and then run tests in debug mode.