Mastermind is a number guessing game where a player tries to guess a series of numbers within 10 turns. Users can register to create an account, and scores will be tracked using a MongoDB database. Users can see the history of their scores on the 'Scores' page after logging in.
A note on creating an account: This is my first time implementing full authentication, and I'm aware that I'm using a somewhat outdated method of doing so. For that reason, it's probably best to not use a password here that you'd use anywhere else!
- Clone or download the repo (e.g,
gh repo clone aemann2/mastermind) - From the root directory, install backend dependencies using
yarn install - In the
/clientdirectory, install frontend dependencies usingyarn install - To run the frontend: run
yarn startin the/clientdirectory. The Frontend is configured to run using the deployed application, so it should start onhttp://localhost:3000without having to start the backend - To run the backend: run
yarn startin the root directory. Note the .env.sample file in/config. In order for the backend to connect to a database, you must fill in the missing MONGO_URI and JWT_SECRET variables with your own. The backend will run onhttp://localhost:5000. - To run frontend tests: run
yarn testin the/clientdirectory - To run backend tests: run
yarn testin the root directory
- At the start of the game the computer will randomly select a pattern of four different numbers from a total of 8 different numbers (the numbers 0 - 7).
- A player will have 10 attempts to guess the number combinations
- At the end of each guess, the computer will provide a response with the following feedback:
- The player guessed a correct number, but in the wrong location
- The player guessed a correct number in the correct location
- The player’s guess was incorrect
Typescript, Node.js, Express, Mongoose, MongoDB, bcrypt, jwt, Mocha, Chai
React, Typescript, CSS Modules, React Testing Library, Jest, Mock Service Worker
- Full stack authentication using bcrypt and jwt
- A custom-made random number generator (which I was forced to build after my IP was blocked from https://www.random.org!)
- Typescript for backend
- Authentication middleware
- Mocha and Chai for backend unit testing
This project was bootstrapped with Create React App.
In the /client directory, you can run:
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.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
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.
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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.