This project is currently in a low-maintenance mode, and community contributions are welcome!
While I have limited time to dedicate to developing new features myself, I am happy to review and merge pull requests for bug fixes and new features.
Please be patient, as review times may vary, but I will do my best to get to all contributions. Your support and collaboration are greatly appreciated in helping CryptoHook grow!
CryptoHook is an open-source, self-hosted Cryptocurrency Payment API. It was designed with a focus on privacy and giving users full control over their payment infrastructure.
The existing code is from an early development stage and should be considered a prototype. It is not recommended for production use.
The following list outlines the features and improvements that were originally planned for CryptoHook. This can serve as inspiration or a starting point for anyone interested in contributing to the project.
- Broader Cryptocurrency Support: Extend beyond the initial set of currencies (only bitcoin currently).
- CI/CD Integration: Implement a pipeline for automated testing and deployment.
- Architectural Shift: Transition from REST to RPC for improved performance (for checking for payments on the blockchain).
- Enhanced Security: Implement more robust authentication and security hardening.
- Docker Support: Provide a
Dockerfilefor easy, containerized deployment. - Expanded Documentation: Comprehensive setup guides, API references, and examples.
-
Clone the repository:
git clone https://github.com/byayex/CryptoHook.git
-
Open the solution in your preferred .NET IDE (e.g., Visual Studio, JetBrains Rider). | I recommend using VS Code and opening the Workspace in the root directory
-
Review the
CryptoHook.Apiand unit test projects to understand the basic structure.
Contributions are the primary way this project will move forward! If you have a bug fix or a new feature, please feel free to:
- Fork the repository.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
I will review all PRs and provide feedback as my time allows. Thank you for helping out!
This project is licensed under the GNU GPLv3 License.