2023-07-08 06:14:05 +00:00
### Introduction
2023-04-20 03:17:43 +00:00
2023-07-08 06:14:05 +00:00
Lume is a nostr client
2023-02-21 07:58:47 +00:00
2023-07-08 06:14:05 +00:00
### Usage
2023-02-21 07:58:47 +00:00
2023-07-08 06:14:05 +00:00
Download Lume for your platform here: [https://github.com/luminous-devs/lume/releases ](https://github.com/luminous-devs/lume/releases )
2023-02-21 07:58:47 +00:00
2023-07-08 06:14:05 +00:00
Supported platform: macOS, Windows and Linux
2023-02-21 14:48:57 +00:00
2023-09-12 09:00:41 +00:00
### Prerequisites
2023-10-02 08:36:20 +00:00
- PNPM or Bun (experiment)
2023-09-12 09:00:41 +00:00
- Tauri: https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-macos
2023-07-08 06:14:05 +00:00
### Develop
2023-02-21 14:48:57 +00:00
2023-07-08 06:14:05 +00:00
Clone project
2023-04-20 03:17:43 +00:00
2023-03-05 02:40:42 +00:00
```
2023-07-08 06:14:05 +00:00
git clone https://github.com/luminous-devs/lume.git & & cd lume
2023-04-20 03:17:43 +00:00
```
2023-07-08 06:14:05 +00:00
Install packages
2023-03-05 02:40:42 +00:00
```
2023-10-02 08:36:20 +00:00
pnpm install
2023-04-07 07:31:14 +00:00
```
2023-09-12 09:00:41 +00:00
Run dev build
2023-03-05 02:40:42 +00:00
```
2023-10-02 08:36:20 +00:00
pnpm tauri dev
2023-03-05 02:40:42 +00:00
```
2023-04-20 03:17:43 +00:00
2023-09-12 09:00:41 +00:00
Generate production build
2023-04-20 03:17:43 +00:00
2023-07-08 06:14:05 +00:00
```
2023-10-02 08:36:20 +00:00
pnpm tauri build
```
2023-10-24 12:57:15 +00:00
#### Nix
Requirements:
1. [Install Nix ](https://zero-to-flakes.com/install )
1. [Setup `direnv` ](https://zero-to-flakes.com/direnv )
2023-10-24 15:26:50 +00: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.