Skip to content

mplumer/sudoku-react

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Netlify Status

LinkedIn


Logo

Sudoku React

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

A mobile-friendly Sudoku game with button controls for any device. Download this PWA to your favorite device so you can play even when you're not online. Not enough time to finish your game? No worries! With persistent storage you don't have to worry about losing your progress if you navigate away from the game. If you get tired of your current game, just press the new game button for a fresh board.

When I decided to pursue this project, I had just recently learned typescript and thought this would be a great way to practice my new found skill. Not only did it provide lots of great typescript experience, it was incredibly logic-heavy and really pushed my limits as a programmer. The experience was difficut, but rewarding...and I'm pretty pleased with how it turned out.

App Gif

App Screenshot

PWA Screenshot

Link to deployed application

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/mplumer/sudoku-react.git
  2. Install NPM packages
    npm install

OR

Go to Max-Sudoku and press the install button inside the address bar.

Usage

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open 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 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 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.

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Max Plumer - LinkedIn - maxplumer12@gmail.com

Project Link: https://github.com/mplumer/sudoku-react

About

A mobile-friendly Sudoku PWA with button controls for any device.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published