Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ayush-848 committed Oct 2, 2024
2 parents ad2420b + db877da commit 06c958e
Show file tree
Hide file tree
Showing 2 changed files with 193 additions and 5 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Greetings

on: [pull_request_target, issues]

jobs:
greeting:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: "👋 Thank you for raising an issue! We appreciate your effort in helping us improve. Our team will review it shortly. Stay tuned!"
pr-message: " 🎉 Thank you for your contribution! Your pull request has been submitted successfully. A maintainer will review it as soon as possible. We appreciate your support in making this project better"
182 changes: 177 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,180 @@
# React + Vite
# Wallet Generator

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
![Wallet Generator Banner](path-to-your-banner-image.png)

Currently, two official plugins are available:
## Table of Contents

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
- [Overview](#overview)
- [Features](#features)
- [Demo](#demo)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Application](#running-the-application)
- [Project Structure](#project-structure)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Overview

**Wallet Generator** is a React-based web application that allows users to generate secure mnemonic seed phrases for cryptocurrency wallets. Leveraging the BIP39 standard, the application facilitates the creation of seed phrases which can be used to set up wallets for both Solana and Ethereum networks. This tool is essential for developers and enthusiasts looking to manage their crypto assets securely.

## Features

- **Mnemonic Generation:** Create secure and random seed phrases using the BIP39 standard.
- **Multi-Wallet Support:** Generate wallets for both Solana and Ethereum networks.
- **Real-Time Analytics:** Integrated with Vercel Analytics for monitoring user interactions.
- **Responsive Design:** Ensures compatibility across various devices and screen sizes.
- **User-Friendly Interface:** Simple and intuitive UI for seamless user experience.

## Demo

![Wallet Generator Demo](path-to-your-demo-image.gif)

## Getting Started

Follow these instructions to set up and run the project locally.

### Prerequisites

Ensure you have the following installed on your machine:

- **Node.js** (v14 or later)
- **npm** (v6 or later) or **yarn**

### Installation

1. **Clone the Repository**

```bash
git clone https://github.com/VedantAnand17/Web3-Wallet.git
```

2. **Navigate to the Project Directory**

```bash
cd Web3-Wallet
```

3. **Install Dependencies**

Using npm:

```bash
npm install
```

Or using yarn:

```bash
yarn install
```

### Running the Application

After installing the dependencies, you can start the development server.

Using npm:

```bash
npm start
```

Or using yarn:

```bash
yarn start
```

The application will run at `http://localhost:3000`. Open this URL in your browser to view the Wallet Generator.

## Project Structure
**Note:** This structure is alterable.

```
Web3-Wallet/
├── node_modules/
├── public/
│ ├── index.html
│ └── ...
├── src/
│ ├── components/
│ │ ├── SolanaWallet.js
│ │ ├── EthWallet.js
│ │ └── MnemonicContainer.js
│ ├── App.js
│ ├── index.js
│ └── ...
├── .gitignore
├── package.json
├── README.md
└── ...
```

- **public/**: Contains the public assets and the main HTML file.
- **src/**: Contains the source code of the application.
- **components/**: Reusable React components.
- **App.js**: The main application component.
- **index.js**: Entry point of the React application.
- **package.json**: Lists project dependencies and scripts.
- **README.md**: Documentation of the project.


## Technologies Used

- **React**: Front-end JavaScript library for building user interfaces.
- **BIP39**: Bitcoin Improvement Proposal for mnemonic seed phrases.
- **Vercel Analytics**: Real-time analytics for monitoring application performance.
- **Tailwind CSS**: Utility-first CSS framework for styling.
- **JavaScript (ES6+)**: Programming language used for building the application.
- **Git & GitHub**: Version control and repository hosting.

## Contributing

Contributions are welcome! Please follow these steps to contribute:

1. **Fork the Repository**

Click the "Fork" button at the top right of this page to create your own forked repository.

2. **Clone Your Fork**

```bash
git clone https://github.com/your-username/Web3-Wallet.git
```

3. **Create a New Branch**

```bash
git checkout -b feature/YourFeatureName
```

4. **Make Your Changes**

Commit your changes with clear and descriptive messages.

5. **Push to Your Fork**

```bash
git push origin feature/YourFeatureName
```

6. **Create a Pull Request**

Navigate to the original repository and click "Compare & pull request" to submit your changes for review.

## License

This project is licensed under the [MIT License](LICENSE).

## Contact

If you have any questions, suggestions, or feedback, feel free to reach out!

- **Author:** Vedant Anand
- **Email:** [email protected]
- **GitHub:** [VedantAnand17](https://github.com/VedantAnand17)

---

0 comments on commit 06c958e

Please sign in to comment.