Magi Coin Compain is an application developed for the integration between your MagiCoin Web Wallet and the authorized Pool by the official website MagiCoin
The application integrates the MagiCoin APIs with the Bowserlab-Pool, Lidonia, and Zpool through HTTPS requests. The objective of this project is personal and aims to monitor the MagiCoin Web Wallet and the running miners from the aforementioned pools. It also allows tracking of balance and recent transactions.
This project is developed entirely in Flutter, which provides the versatility for multi-platform development. To work on this project, it is recommended to have the following resources installed:
You can use your preferred IDE such as VSCode, Android Studio, JetBrain, or others.
Follow the steps below to install and set up the Flutter project locally:
-
Make sure you have Flutter SDK installed. If not, refer to the official Flutter documentation for installation instructions.
-
Clone the repository to your local machine using the following command:
$ git clone https://github.com/rafgui12/MagiCoinCompanion.git
- Navigate to the project directory:
$ cd {$YourPath}/MagiCoinCompanion
- Run the following command to fetch the project dependencies:
$ flutter pub get
-
Connect a physical device or start an emulator.
-
Build and run the project using the following command:
$ flutter run
This code is free to use and open to contributions and bug notifications. The goal is to achieve unified integration between the pools and the Web Wallet, and it is not developed for profit.
The following is not allowed:
- Distribution of payment codes derived from this code. If such distribution occurs, a proper request will be made for the removal or withdrawal of such codes.
- Publication in third-party stores such as Snapcraft, Google Play Store, Windows Store, among others, of codes derived from this code.
This code is for personal use only, and the following is allowed:
- Personal modifications in local versions.
- Creation of customized local versions for other unauthorized pools.
Using this code responsibly helps us have a developing tool that supports and benefits many people. Please be responsible with the code.
We welcome contributions to improve the project and make it even better! If you would like to contribute, please follow these guidelines:
- Fork the repository and create a new branch for your contribution.
- Make your changes and ensure they are properly tested.
- Commit your changes with descriptive commit messages.
- Push your changes to your forked repository.
- Submit a pull request, explaining the changes you have made and why they should be merged.
Please note that all contributions should align with our code of use. By contributing to this project, you agree to abide by the code of conduct.
We appreciate your time and effort in contributing to this project!
If you have any questions, suggestions, or need assistance with this project, feel free to reach out to me. You can contact me via:
- Email: rafael@rafgui.com
- Webpage: rafgui.com
- GitHub: rafgui12
I'm always happy to hear from you and help in any way I can. Don't hesitate to reach out!
