Skip to content

colatkinson/seppuku

Repository files navigation

Logo

Seppuku

An open source sudoku game

Website GPLv3 license Github tag

screencast

Seppuku runs entirely client-side, and is written with React, Redux, and Typescript, and uses the very nice semantic-ui-react and react-snapshot libraries. It implements algorithms from the paper Sudoku Puzzles Generating: from Easy to Evil.

Check out a live demo!

Installing / Getting Started

git clone [email protected]:colatkinson/seppuku.git
yarn install
yarn start

This will open up a browser window and run a development server. Then you can play to your heart's content.

Production Builds

To generate an optimized production build, simply run

yarn build

This will create the webpack bundle, and will create a static index.html with react-snapshot.

Deployment

Currently, the deploy script is made for Surge. Just run yarn deploy and it will serve the site statically. It expects the domain name to be specified in a CNAME file in the root directory, and will fail without this.

Contributing

Contributions are happily accepted! Just make sure that your code passes TSLint and generally follows the conventions.

Licensing

Seppuku is offered under the GPLv3. If anyone wants to make a close-source copy of this... Why?