Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ducheharsh authored Aug 15, 2024
1 parent f8b7a2c commit 0cbc240
Showing 1 changed file with 76 additions and 1 deletion.
77 changes: 76 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,80 @@
# theWallet
A simple wallet application (creating user + merchant side applications managed in a monorepo with implementaion of transactions)

A simple wallet application that includes both user and merchant side applications, managed in a monorepo with implementation of onRamp, peer-to-peer & merchant transactions

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Introduction

theWallet is a comprehensive wallet application designed to manage user and merchant transactions efficiently. This project is structured as a monorepo, making it easier to manage and develop both sides of the application simultaneously.

## Backend architecture
![image](https://github.com/user-attachments/assets/30526b1f-0e40-48a2-b586-a06528f6ffc9)

## Features

- User and Merchant account management
- Transaction processing
- Monorepo structure for streamlined development
- Built with TypeScript, CSS, and JavaScript

## Installation

To get started with theWallet, follow these steps:

1. **Clone the repository:**

```bash
git clone https://github.com/ducheharsh/theWallet.git
cd theWallet
```

2. **Install dependencies:**

```bash
npm install
```

3. **Set up environment variables:**

Create a `.env` file in the root directory and add the necessary environment variables.

4. **Run the application:**

```bash
npm start
```

## Usage

After installation, you can start using theWallet by running the application. The user interface will guide you through creating accounts, managing transactions, and more.

## Contributing

We welcome contributions to theWallet! To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Open a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact

For any questions or feedback, please reach out to [Harsh Duche](https://github.com/ducheharsh).

---

0 comments on commit 0cbc240

Please sign in to comment.