lume/README.md

### Introduction

Lume is a nostr client

### Usage

Download Lume for your platform here: [https://github.com/luminous-devs/lume/releases](https://github.com/luminous-devs/lume/releases)

Supported platform: macOS, Windows and Linux

### Prerequisites

- PNPM or Bun (experiment)

- Tauri: https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-macos

### Develop

Clone project

```
git clone https://github.com/luminous-devs/lume.git && cd lume
```

Install packages

```
pnpm install
```

Run dev build

```
pnpm tauri dev
```

Generate production build

```
pnpm tauri build
```

#### Nix 

Requirements:

1. [Install Nix](https://zero-to-flakes.com/install)
1. [Setup `direnv`](https://zero-to-flakes.com/direnv)

`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.
update 2023-07-08 06:14:05 +00:00			`### Introduction`
updated README 2023-04-20 03:17:43 +00:00
update 2023-07-08 06:14:05 +00:00			`Lume is a nostr client`
don't hate me, old git is fuck up 2023-02-21 07:58:47 +00:00
update 2023-07-08 06:14:05 +00:00			`### Usage`
don't hate me, old git is fuck up 2023-02-21 07:58:47 +00:00
update 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)`
don't hate me, old git is fuck up 2023-02-21 07:58:47 +00:00
update 2023-07-08 06:14:05 +00:00			`Supported platform: macOS, Windows and Linux`
updated README 2023-02-21 14:48:57 +00:00
polish nwc connection flow 2023-09-12 09:00:41 +00:00			`### Prerequisites`

new app icon 2023-10-02 08:36:20 +00:00			`- PNPM or Bun (experiment)`
polish nwc connection flow 2023-09-12 09:00:41 +00:00
			`- Tauri: https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-macos`

update 2023-07-08 06:14:05 +00:00			`### Develop`
updated README 2023-02-21 14:48:57 +00:00
update 2023-07-08 06:14:05 +00:00			`Clone project`
updated README 2023-04-20 03:17:43 +00:00
docs: update README.md 2023-03-05 02:40:42 +00:00			```
update 2023-07-08 06:14:05 +00:00			`git clone https://github.com/luminous-devs/lume.git && cd lume`
updated README 2023-04-20 03:17:43 +00:00			```

update 2023-07-08 06:14:05 +00:00			`Install packages`
docs: update README.md 2023-03-05 02:40:42 +00:00
			```
new app icon 2023-10-02 08:36:20 +00:00			`pnpm install`
added init-db script 2023-04-07 07:31:14 +00:00			```

polish nwc connection flow 2023-09-12 09:00:41 +00:00			`Run dev build`
docs: update README.md 2023-03-05 02:40:42 +00:00
			```
new app icon 2023-10-02 08:36:20 +00:00			`pnpm tauri dev`
docs: update README.md 2023-03-05 02:40:42 +00:00			```
updated README 2023-04-20 03:17:43 +00:00
polish nwc connection flow 2023-09-12 09:00:41 +00:00			`Generate production build`
updated README 2023-04-20 03:17:43 +00:00
update 2023-07-08 06:14:05 +00:00			```
new app icon 2023-10-02 08:36:20 +00:00			`pnpm tauri build`
			```
Nix dev environment 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)

typo + cleanup 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.