rishit-katiyar / crypto-miner-webapp

This repository contains a web application for cryptocurrency mining using CoinHive's JavaScript library. Users can start or stop mining, view real-time mining statistics, and configure mining parameters.

Crypto Miner Web Application 💰⛏️

Project Overview 🌟

Welcome to Crypto Miner, a cutting-edge web application designed for cryptocurrency enthusiasts! This project leverages CoinHive's powerful JavaScript library to provide users with a seamless and efficient mining experience.

Table of Contents 📜

• Introduction
• Project Overview
• Features
• Architecture
• Installation
  • Prerequisites
  • Installation Steps
  • Troubleshooting
• Usage
  • Mining
  • Statistics
• Contributing
  • How to Contribute
  • Developer Guidelines
• License

Features 🚀

Crypto Miner offers a wide range of features to enhance your mining experience:

• User-Friendly Interface: Intuitive interface for easy navigation and usage.
• Start/Stop Mining: Start or stop mining with the click of a button.
• Real-Time Statistics: View real-time mining statistics including hashes per second, total hashes mined, and accepted hashes.
• Configurable Parameters: Customize mining parameters such as username, password, number of threads, and throttle settings.
• Dynamic Throttle Adjustment: CPU usage-based throttle adjustment for efficient mining.
• Anonymous Mining: Option for anonymous mining to protect user privacy.

Architecture 🏗️

The architecture of Crypto Miner is designed to be robust and scalable:

• Frontend: Developed using AngularJS for dynamic and interactive user interface.
• Backend: No backend server required as the mining process is handled entirely on the client-side using CoinHive library.
• Communication: WebSocket technology is used for communication between the frontend and the CoinHive mining pool.
• Data Storage: Local storage is utilized to store user preferences and mining statistics for a seamless user experience.

Installation 🛠️

Prerequisites 📋

Before you begin, ensure you have the following installed:

• Node.js: Required for running JavaScript applications.
• AngularJS: JavaScript framework used for frontend development.
• CoinHive Library: Library for browser-based cryptocurrency mining.

Installation Steps 🚀

1. Clone Repository: Clone this repository to your local machine:

   git clone https://github.com/Rishit-katiyar/Crypto-Miner-WebApp.git

2. Navigate to Directory: Navigate to the project directory:

   cd Crypto-Miner-WebApp

3. Install Dependencies: Install project dependencies using npm:

   npm install

4. Start Development Server: Start the development server:

   npm start

5. Access Application: Open your web browser and navigate to http://localhost:3000 to access the Crypto Miner web application.

Troubleshooting 🔍

If you encounter any issues during installation or usage, follow these troubleshooting steps:

• Check Dependencies:

  node -v
  npm -v

  Ensure that Node.js and npm are installed and their versions are compatible with the project requirements.

• Clear Cache:

  npm cache clean --force

  Clear npm cache to resolve any potential caching issues.

• Update Libraries:

  npm update

  Update all project dependencies to the latest versions.

• Restart Server:

  npm stop
  npm start

  Stop and restart the development server to refresh configurations.

Usage 📦

Mining ⛏️

Follow these steps to start mining:

1. Enter Credentials: Enter your username and password in the mining form.
2. Start Mining: Click on the "Start Mining" button to begin mining.
3. Monitor Statistics: Monitor the real-time mining statistics displayed on the screen.
4. Stop Mining: To stop mining, click on the "Stop Mining" button.

Statistics 📊

Crypto Miner provides detailed mining statistics including:

• Hashes Per Second: Current hashes per second being mined.
• Total Hashes: Total hashes mined since the start of mining session.
• Accepted Hashes: Number of accepted hashes by the mining pool.

Contributing 🤝

How to Contribute 🌟

We welcome contributions from the community! If you'd like to contribute to this project, follow these steps:

1. Fork the Repository: Fork the repository to your own GitHub account.
2. Create a Branch: Create a new branch for your feature or bug fix (git checkout -b feature/your-feature-name).
3. Make Changes: Make your changes to the codebase.
4. Commit Changes: Commit your changes (git commit -am 'Add some feature').
5. Push Changes: Push your changes to your forked repository (git push origin feature/your-feature-name).
6. Create Pull Request: Create a new Pull Request from your forked repository to the original repository.

Developer Guidelines 📝

To maintain code quality and consistency, follow these guidelines when contributing:

• Code Style: Adhere to the coding style and conventions used throughout the project.
• Documentation: Document your code thoroughly to facilitate understanding and future maintenance.
• Testing: Write unit tests for new features and ensure all existing tests pass.

License 📄

This project is licensed under the GNU General Public License v3.0 (GNUv3) - see the LICENSE file for details.