https://github.com/complexlity/sudoku-frame-noir
https://github.com/complexlity/sudoku-frame-noir
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/complexlity/sudoku-frame-noir
- Owner: Complexlity
- Created: 2024-02-08T06:32:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-30T08:42:42.000Z (about 2 years ago)
- Last Synced: 2025-09-03T10:39:50.207Z (8 months ago)
- Language: TypeScript
- Homepage: https://sudoku-frame-noir.vercel.app
- Size: 3.09 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SUDOKU on Frames
This is a [Farcaster Frame](https://docs.farcaster.xyz/reference/frames/spec) which lets users play sudoku on the platform.
The solution validator has been written in [Noir](https://noir-lang.org/). Which is a domain specific language used for generating zero knowledge proofs
## Pre-requisite
- Nodejs 18+
## Getting Started
- Clone the repository
```
git clone https://github.com/Complexlity/sudoku-frame-noir.git
```
- Install dependencies
```
npm install
```
- Update ENV
```.env
HOST=http://localhost:3000
PROOF_API_URL=http://localhost:3000/api/proof
```
These are the only two values needed in development mode. In production, you should change the `HOST` to the url where the application is deployed.
Also the `PROOF_API_URL` (/api/proof) for some reason, does not work when deployed on vercel so I have deployed the api differently using express and used that url.
You can find the repo on [Github - https://github.com/Complexlity/sudoku-noir-backend](https://github.com/Complexlity/sudoku-noir-backend). The codes work exactly the same way.
- Start Development Server
```
npm run dev
```
The frame would be started on [http://localhost:3000](http://localhost:3000)
## Resources
- [Noir Docs](https://noir-lang.org/docs/)
- [Crypdoku's](https://github.com/guipublic/crypdoku) Tutorial on Noir - [Link](https://drive.google.com/file/d/1D4XCdiIZVjUW1JHDoMW3pG-15mgjMm9E/)
- [Sudoku, Worldle and Trivia in Noir](https://github.com/ruizehung/Zero-Knowledge-Sudoku-Wordle-Trivia) by [ruizehung](https://github.com/ruizehung/)
- [Learn Noir in an afternoon or get your money back](https://www.youtube.com/watch?v=rEVPui0_rig&t=3020s) by Jose Pedro