Skip to content

kotlearn/minesweeperk

Repository files navigation

MinesweeperK: A Compose Multiplatform Minesweeper Game

Welcome to the MinesweeperK project! This repository accompanies the Kotlearn YouTube series, where we build a Minesweeper game using Compose Multiplatform. The game runs on Android, iOS, and desktop platforms (Windows, macOS), following clean architecture and a multi-module project structure.


Repository Structure

Main Branch

The main branch contains the latest version of the project, including updates and refinements made throughout the series. It represents the complete and up-to-date MinesweeperK project.

Episodes

Each episode of the series has its own branch, which represents a snapshot of the project at the end of that episode. This allows you to easily explore or download the code relevant to any specific video.


How to Use This Repository

Following Along with the Series

  1. Clone the repository:
    git clone https://github.com/kotlearn/minesweeperk.git
    cd minesweeperk
  2. Check out a specific episode branch:
    git checkout 01-project-setup
    Replace 01-project-setup with the desired episode branch.

Links and Resources

  • YouTube Playlist: MinesweeperK Series
  • Episode-Specific Code: Links to branches will be provided in video descriptions.

Technologies Used

  • Compose Multiplatform for shared UI across platforms
  • Navigation Component for handling navigation
  • Room Database for persistent storage
  • Koin DI for dependency injection
  • Clean Architecture to structure the codebase

Contributing

This project is primarily for educational purposes, but contributions are welcome! If you’d like to improve or extend the project, feel free to open an issue or create a pull request.

Contributors

Thanks to everyone that's contributed so far!

License

This project is licensed under the 0BSD License.


Happy coding, and enjoy learning Compose Multiplatform with MinesweeperK!