lume/README.md

51 lines
885 B
Markdown
Raw Normal View History

2023-07-08 13:14:05 +07:00
### Introduction
2023-04-20 10:17:43 +07:00
2023-07-08 13:14:05 +07:00
Lume is a nostr client
2023-02-21 14:58:47 +07:00
2023-07-08 13:14:05 +07:00
### Usage
2023-02-21 14:58:47 +07:00
2024-02-01 09:15:25 +07:00
Download Lume for your platform here: [https://github.com/lumehq/lume/releases](https://github.com/lumehq/lume/releases)
2023-02-21 14:58:47 +07:00
2023-07-08 13:14:05 +07:00
Supported platform: macOS, Windows and Linux
2023-02-21 21:48:57 +07:00
2023-09-12 16:00:41 +07:00
### Prerequisites
2023-10-02 15:36:20 +07:00
- PNPM or Bun (experiment)
2023-09-12 16:00:41 +07:00
- Tauri: https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-macos
2023-07-08 13:14:05 +07:00
### Develop
2023-02-21 21:48:57 +07:00
2023-07-08 13:14:05 +07:00
Clone project
2023-04-20 10:17:43 +07:00
2023-03-05 09:40:42 +07:00
```
2024-02-01 09:15:25 +07:00
git clone https://github.com/lumehq/lume.git && cd lume
2023-04-20 10:17:43 +07:00
```
2023-07-08 13:14:05 +07:00
Install packages
2023-03-05 09:40:42 +07:00
```
2023-10-02 15:36:20 +07:00
pnpm install
2023-04-07 14:31:14 +07:00
```
2023-09-12 16:00:41 +07:00
Run dev build
2023-03-05 09:40:42 +07:00
```
2023-10-02 15:36:20 +07:00
pnpm tauri dev
2023-03-05 09:40:42 +07:00
```
2023-04-20 10:17:43 +07:00
2023-09-12 16:00:41 +07:00
Generate production build
2023-04-20 10:17:43 +07:00
2023-07-08 13:14:05 +07:00
```
2023-10-02 15:36:20 +07:00
pnpm tauri build
```
2023-10-24 14:57:15 +02:00
#### Nix
Requirements:
1. [Install Nix](https://zero-to-flakes.com/install)
1. [Setup `direnv`](https://zero-to-flakes.com/direnv)
2023-10-24 17:26:50 +02:00
`cd` into the root folder of the project to enter `nix develop` shell. Run `direnv allow` (only once). Then run `pnpm` or `bun` (experimental) commands as described above.