Skip to content

Commit 2c9762a

Browse files
committed
Update deps and README
Signed-off-by: Ken Anderson <ken@launchbadge.com>
1 parent 7480c22 commit 2c9762a

13 files changed

Lines changed: 9438 additions & 36078 deletions

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,80 @@ transfer hbars, and so much more.
2626

2727
- <img width="16" src="./src/assets/clock.svg">&nbsp;&nbsp;**Hedera™ Staking**. Stake your Hbar to Nodes or Accounts and earn rewards; see rewards calculations for the current staking period. **Not Yet Supported for Ledger™ Hardware Wallets**
2828

29+
## Setup and Running
30+
31+
### Prerequisites
32+
33+
- Node.js (v16 or higher)
34+
- pnpm (v6 or higher)
35+
- Git
36+
37+
### Installation
38+
39+
1. Clone the repository:
40+
```bash
41+
git clone https://github.com/hashgraph/myhbarwallet.git
42+
cd myhbarwallet
43+
```
44+
45+
2. Install dependencies:
46+
```bash
47+
pnpm install
48+
```
49+
50+
### Development
51+
52+
To run the development server:
53+
54+
```bash
55+
pnpm dev
56+
```
57+
58+
This will start the development server at `http://localhost:5173`
59+
60+
### Building for Production
61+
62+
To build the web application:
63+
64+
```bash
65+
pnpm build
66+
```
67+
68+
The built files will be in the `dist/web` directory.
69+
70+
### Building for Desktop (Electron)
71+
72+
To build the desktop application:
73+
74+
```bash
75+
pnpm electron:build
76+
```
77+
78+
This will create the desktop application in the `dist/electron` directory.
79+
80+
### Running Tests
81+
82+
Run end-to-end tests:
83+
```bash
84+
pnpm test:e2e:run
85+
```
86+
87+
Run unit tests:
88+
```bash
89+
pnpm test:unit:run
90+
```
91+
92+
### Available Scripts
93+
94+
- `pnpm dev` - Start development server
95+
- `pnpm build` - Build for production
96+
- `pnpm electron:dev` - Run desktop app in development mode
97+
- `pnpm electron:build` - Build desktop application
98+
- `pnpm test:e2e:run` - Run end-to-end tests
99+
- `pnpm test:unit:run` - Run unit tests
100+
- `pnpm fmt` - Format code with ESLint
101+
- `pnpm check:types` - Check TypeScript types
102+
29103
## License
30104

31105
Copyright 2022 Hedera Hashgraph LLC.

0 commit comments

Comments
 (0)