nostros/README.md

83 lines
2.6 KiB
Markdown
Raw Normal View History

2022-10-26 18:42:45 +00:00
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a3db59f4a45a43159cb129386b937a2a)](https://www.codacy.com/gh/KoalaSat/nostros/dashboard?utm_source=github.com&utm_medium=referral&utm_content=KoalaSat/nostros&utm_campaign=Badge_Grade)
2022-10-25 23:06:23 +00:00
[![Frontend Build](https://github.com/KoalaSat/nostros/actions/workflows/android-build.yml/badge.svg?branch=main)](https://github.com/KoalaSat/nostros/actions/workflows/android-build.yml)
2022-10-29 13:51:57 +00:00
[![release](https://img.shields.io/github/v/release/KoalaSat/nostros)](https://github.com/KoalaSat/nostros/releases)
2022-10-25 23:04:19 +00:00
[![Apache 2 license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/KoalaSat/nostros/blob/main/LICENSE)
2022-10-31 11:03:38 +00:00
[![Telegram](https://img.shields.io/badge/chat-telegram-brightgreen)](https://t.me/+zhvZAE9L0X40ZjI0)
2022-10-24 20:35:21 +00:00
2022-10-25 19:32:45 +00:00
![nostros_logo](https://user-images.githubusercontent.com/111684255/197865267-1701b33b-2eb9-4704-86eb-a6ea8861fe1e.png)
2022-10-24 17:43:22 +00:00
2022-10-29 21:52:35 +00:00
Wellcome to the Nostros project, a NOSTR mobile client.
2022-10-24 17:43:22 +00:00
2022-10-26 20:15:41 +00:00
Chanel Id:
2022-10-29 13:38:04 +00:00
2022-10-26 20:15:04 +00:00
```
2022-10-30 10:27:05 +00:00
8d37308d97356600f67a28039d598a52b8c4fa1b73ef6f2e7b7d40197c3afa56
2022-10-26 20:15:19 +00:00
```
2022-10-26 20:15:04 +00:00
2022-10-24 17:47:25 +00:00
# Getting Started
2022-10-24 17:43:22 +00:00
2022-10-29 19:25:36 +00:00
What is Nostr: https://github.com/nostr-protocol/nostr
2022-11-03 21:42:58 +00:00
Local setup: https://github.com/KoalaSat/nostros/blob/main/SETUP.md
2022-10-24 17:43:22 +00:00
2022-10-24 17:47:25 +00:00
# Some Features to Work On
2022-10-25 02:29:59 +00:00
2022-10-24 19:58:26 +00:00
### Bugs
2022-10-25 02:29:59 +00:00
2022-10-25 13:13:54 +00:00
- [x] User info missing on first start
2022-10-29 13:38:35 +00:00
- [x] i18n not loading
2022-10-29 13:40:10 +00:00
- [x] Logging out and in again does not work
2022-11-01 00:14:19 +00:00
- [x] Clipboard library not working
2022-11-04 22:12:28 +00:00
- [x] Some user images are not loading (webp)
2022-10-30 10:09:34 +00:00
- [ ] Websocket connections closed when the app goes to background for too long
2022-10-25 02:29:59 +00:00
2022-10-24 18:14:04 +00:00
### Basics
2022-10-25 02:29:59 +00:00
2022-11-01 01:30:08 +00:00
- [x] Infinite Load
2022-10-29 17:57:25 +00:00
- [x] Go to replied event
2022-11-05 18:38:01 +00:00
- [x] Relays management (add, remove and recomend)
2022-11-01 02:42:24 +00:00
- [x] Random Key Generator
2022-10-31 13:20:50 +00:00
- [x] Watch only mode
2022-10-25 02:29:59 +00:00
2022-10-24 18:14:04 +00:00
### Home
2022-10-25 02:29:59 +00:00
2022-10-24 17:43:22 +00:00
- [ ] Public Room
- [ ] Other Rooms
2022-10-25 02:29:59 +00:00
### Profile
2022-10-25 13:25:26 +00:00
2022-10-25 11:47:50 +00:00
- [ ] Verify NIP-05 https://github.com/nostr-protocol/nips/blob/master/05.md
2022-10-24 17:43:22 +00:00
- [ ] Verify LNURL https://github.com/andrerfneves/lightning-address
2022-10-25 02:29:59 +00:00
2022-10-24 18:14:04 +00:00
### Contacts
2022-10-25 02:29:59 +00:00
2022-11-06 20:13:45 +00:00
- [x] Followers list
2022-10-24 17:43:22 +00:00
- [ ] Direct Messages https://github.com/nostr-protocol/nips/blob/master/04.md
2022-10-25 02:29:59 +00:00
2022-10-24 18:14:04 +00:00
### Note
2022-10-25 13:25:26 +00:00
2022-10-25 11:46:02 +00:00
- [ ] Autoscroll to reply
2022-10-24 17:43:22 +00:00
- [ ] Mentions https://github.com/nostr-protocol/nips/blob/master/08.md
- [ ] Reactions https://github.com/nostr-protocol/nips/blob/master/25.md
- [ ] Deletion https://github.com/nostr-protocol/nips/blob/master/09.md
- [ ] Tag Users https://github.com/nostr-protocol/nips/blob/master/10.md
2022-10-25 11:46:02 +00:00
- [ ] Load entire thread
2022-10-25 02:29:59 +00:00
2022-10-24 18:14:04 +00:00
### Send
2022-10-25 02:29:59 +00:00
2022-10-24 17:43:22 +00:00
- [ ] Mentions https://github.com/nostr-protocol/nips/blob/master/08.md
2022-10-25 02:29:59 +00:00
2022-10-24 18:14:04 +00:00
### Config
2022-10-25 02:29:59 +00:00
2022-11-05 18:38:41 +00:00
- [x] Private Key download
2022-10-24 17:47:25 +00:00
# Kudos
- Inspired on https://github.com/jb55/nostr-js and https://github.com/fiatjaf/nostr-tools
- Discovered thanks to https://lunaticoin.com
2022-11-08 18:58:33 +00:00
# Support
2022-10-24 17:43:22 +00:00
2022-11-08 18:21:56 +00:00
Project's Address: bc1q8xjlxxwpsck429zr7ff466yax0k3lhp9fmm2et
2022-11-08 18:58:33 +00:00
LNURL: nostros@getalby.com