Upload project

Author: cau777

.github/workflows/workflow.yml

@@ -0,0 +1,28 @@
+name: GitHub Pages Deploy
+
+on:
+  push:
+    branches:
+      - "master"
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [ 14.17 ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Build WASM and page
+        run: npm install && npm run gh-build
+
+      - name: Deploy
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: build

README.md

@@ -1,46 +1,15 @@
-# Getting Started with Create React App
+# Sudoku Solver
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+An algorithm made in rust to solve sudoku boards of various sizes efficiently. It's implemented in Rust and runs in the
+browser using Web Assembly. The project includes a modern interface made in React to visualise the algorithm
+step-by-step.
 
-## Available Scripts
+## Features
+* 3 board options: 4x4 9x9 16x16
+* Generation of random Sudoku puzzles
+* Algorithm made in Rust to solve puzzles in milliseconds
+* Step-by-step visualization of the solution with explanations
 
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+## Screenshots
+* ![Empty board](https://github.com/cau777/sudoku_solver/blob/master/screenshots/empty_board.png)
+* ![Solution step](https://github.com/cau777/sudoku_solver/blob/master/screenshots/solution_step.png)

package.json

@@ -2,6 +2,7 @@
   "name": "sudoku_solver",
   "version": "0.1.0",
   "private": true,
+  "homepage": "https://cau777.github.com/sudoku_solver",
   "dependencies": {
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.3.0",
@@ -23,7 +24,8 @@
     "test": "react-scripts test",
     "eject": "react-scripts eject",
     "build:wasm:dev": "cd wasm && wasm-pack build --target web --out-dir pkg --dev",
-    "build:wasm": "cd wasm && wasm-pack build --target web --out-dir pkg --release -- --features wasm_alloc"
+    "build:wasm": "cd wasm && wasm-pack build --target web --out-dir pkg --release -- --features wasm_alloc",
+    "gh-pages": "npm run build:wasm && npm run build"
   },
   "eslintConfig": {
     "extends": [

public/index.html

@@ -24,7 +24,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>React App</title>
+    <title>Sudoku Solver</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

screenshots/empty_board.png

@@ -120,10 +120,7 @@ export const SudokuController: React.FC<Props> = (props) => {
                 readonly={state.steps !== null}></SudokuBoard>
             <div className={"buttons"}>
                 <select defaultValue={3}
-                        onChange={(e) => setState({
-                            ...state,
-                            board: Board.default(Number.parseInt(e.currentTarget.value))
-                        })}>
+                        onChange={(e) => setState(defaultState(Board.default(Number.parseInt(e.currentTarget.value))))}>
                     <option value={2}>4x4</option>
                     <option value={3}>9x9</option>
                     <option value={4}>16x16</option>
@@ -149,8 +146,12 @@ export const SudokuController: React.FC<Props> = (props) => {
                     :
                     <>
                         <button onClick={hideSolution}>Hide solution</button>
-                        <button disabled={state.currentStep <= 0} onClick={() => changeCurrentStep(state.currentStep! - 1, state.steps!)}>Prev step</button>
-                        <button disabled={state.currentStep >= state.steps!.length - 1} onClick={() => changeCurrentStep(state.currentStep! + 1, state.steps!)}>Next step</button>
+                        <button disabled={state.currentStep <= 0}
+                                onClick={() => changeCurrentStep(state.currentStep! - 1, state.steps!)}>Prev step
+                        </button>
+                        <button disabled={state.currentStep >= state.steps!.length - 1}
+                                onClick={() => changeCurrentStep(state.currentStep! + 1, state.steps!)}>Next step
+                        </button>
                     </>
                 }
 

screenshots/solution_step.png

@@ -26,6 +26,8 @@ harness = false
 [profile.release]
 lto = true
 opt-level = 3
+codegen-units = 1
+panic = "abort"
 
 [features]
 wasm_alloc = ["wee_alloc/default"]

src/SudokuController.tsx

@@ -87,7 +87,7 @@ impl<const SIZE: usize, const BLOCK_SIZE: usize> SudokuSolver<SIZE, BLOCK_SIZE>
 
                 if self.should_add() {
                     info_stack.push_front(ReportStep {
-                        message: format!("Tried value {} in {} {}", possible, row, col),
+                        message: format!("Tried value {} in {},{}", possible, row, col),
                         highlight_row: Some(row as u8),
                         highlight_col: Some(col as u8),
                         highlight_block: None,