GitHub - Oia20/PopALockDaily: The open-source daily puzzle game.

🔐 Pop A Lock

The open-source daily puzzle game where you attempt to pop a lock.

🚀 Overview

Pop A Lock is a fun, puzzle game inspired by the popular game Wordle, and a Reddit Post I stumbled upon some time ago. The game is open-source, inviting developers and enthusiasts to contribute to its evolution.

✨ Features

• 🎮 Daily Puzzle: A new number combination with hints is generated once per day.
• 🧠 Brain Workout: Strengthen your problem-solving skills with strategic guessing.
• ♾️ Infinite Mode: Play lock after lock without having to wait for the next day.
• 🌍 Open Source: Free to use, modify, and contribute.

🎯 How to Play

1. Functionally Pop A Lock works like Wordle, but with numbers instead of letters.
2. You get 4 guesses per day
3. Use the hints to help you crack the code, without them it's near impossible to crack the code.
4. Check back the next day for a new puzzle!

🔧 Installation/Run Locally

Clone Repo

git clone https://github.com/Oia20/PopALockDaily.git

Client Side

cd PopALockDaily/popalock
npm install
npm run dev

Make sure to change the fetchUrl variable at the top of the popalockDaily.tsx file.

Server Side

This will require you to have a database you can connect to.

cd PopALockDaily/server
npm install

Make your way to server/src/data-source.ts and add in your database connection info.

Now you should be able to start the server.

🌱 Contributing

We welcome contributions! Feel free to open an issue or submit a pull request if you'd like to help improve Pop A Lock.

• Fork the repository
• Create a new branch (git checkout -b feature-branch)
• Make your changes
• Commit your changes (git commit -m 'Add some feature')
• Push to the branch (git push origin feature-branch)
• Open a pull request

🛠 Tech Stack

🏆 Credits

Built with ❤️ by Jacob Dement.

3D Lock model created by brandon_grey

📜 License

This project is licensed under the MIT License.

Give it a go, and start popping those locks! 🔐