Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bijithpn/flutter-game
Flutter puzzle game with Powerful Golang API.
https://github.com/bijithpn/flutter-game
flutter-bloc flutter-game game golong
Last synced: 19 days ago
JSON representation
Flutter puzzle game with Powerful Golang API.
- Host: GitHub
- URL: https://github.com/bijithpn/flutter-game
- Owner: bijithpn
- License: mit
- Created: 2024-11-01T06:13:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-13T20:06:23.000Z (3 months ago)
- Last Synced: 2024-11-24T01:46:00.787Z (3 months ago)
- Topics: flutter-bloc, flutter-game, game, golong
- Language: Go
- Homepage:
- Size: 881 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎮Flutter Games
`flutter_game` is a Flutter application that utilizes APIs from the [Shadify](https://github.com/cheatsnake/shadify) project to provide a rich gaming experience. This app leverages the backend APIs to interact with various game modules and offer gameplay functionalities.
## Project Overview
This project is designed to offer seamless access to different game functionalities through a user-friendly interface. The APIs provided by the Shadify project are crucial for the app's operation, enabling features such as game logic, scoring, and data management.
## Available Games
The following games are available within the app and their API documentation:
- [Sudoku](./backend/docs/modules/sudoku.md)
- [Takuzu](./backend/docs/modules/takuzu.md)
- [Set](./backend/docs/modules/set.md)
- [Math](./backend/docs/modules/math.md)
- [Schulte](./backend/docs/modules/schulte.md)
- [Minesweeper](./backend/docs/modules/minesweeper.md)
- [Wordsearch](./backend/docs/modules/wordsearch.md)
- [Anagram](./backend/docs/modules/anagram.md)
- [Countries](./backend/docs/modules/countries.md)
- [Camp](./backend/docs/modules/camp.md)
- [Kuromasu](./backend/docs/modules/kuromasu.md)
- [Memory](./backend/docs/modules/memory.md)
## Backend Setup
For detailed instructions on setting up the backend using the Shadify project, please refer to the [`backend/readme.md`](./backend/README.md) file located in the backend directory of this repository. This document provides comprehensive steps for configuring the backend, which is built using Go, to work with the Flutter app.
## Features
- User-friendly interface for various games
- Integration with Shadify APIs for game functionalities
- Efficient data management and gameplay experience
- State management using BLoC pattern
- Networking implemented with Dio for API calls
## Installation
To get started with the `flutter_game` project, follow these steps:
### 1. Clone the repository:
```bash
git clone https://github.com/bijithpn/Flutter-Games.git
```
### 2. Navigate to the project directory:
```bash
cd flutter_game
```
### 3. Install the necessary dependencies:
```bash
flutter pub get
```
### 4. Set up the backend server for the APIs. For documentation, refer to the [`backend/readme.md`](./backend/README.md) file.
## Acknowledgments
Special thanks to the contributors and maintainers of the [Shadify](https://github.com/cheatsnake/shadify) project for providing the APIs that power this application. Their efforts have been instrumental in enabling the functionalities within the Flutter game.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! If you would like to contribute to this project, please follow these steps:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/YourFeatureName
```
3. Make your changes and commit them:
```bash
git commit -m "Add your message here"
```
4. Push to the branch:
```bash
git push origin feature/YourFeatureName
```
5. Open a pull request.
For further details and updates, feel free to check the documentation in the `backend` folder and explore the game's capabilities!