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)
|
|
|
|
[![release](https://img.shields.io/github/v/release/KoalaSat/nostros?include_prereleases)](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-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-25 02:29:59 +00:00
|
|
|
Wellcome to the NOSTROS project.
|
2022-10-24 17:43:22 +00:00
|
|
|
|
2022-10-24 17:47:25 +00:00
|
|
|
# Getting Started
|
2022-10-24 17:43:22 +00:00
|
|
|
|
2022-10-24 21:03:53 +00:00
|
|
|
## Required Libraries and Frameworks
|
2022-10-25 02:29:59 +00:00
|
|
|
|
2022-10-24 17:43:22 +00:00
|
|
|
- Node 16.x
|
|
|
|
- JDK 17.0.x
|
|
|
|
- (Android) Android Studio SKD
|
|
|
|
- yarn
|
|
|
|
|
2022-10-24 17:47:25 +00:00
|
|
|
# Running
|
2022-10-24 17:43:22 +00:00
|
|
|
|
|
|
|
- Open a virtual device
|
2022-10-24 17:57:06 +00:00
|
|
|
- Install
|
2022-10-25 02:29:59 +00:00
|
|
|
|
2022-10-24 17:57:06 +00:00
|
|
|
```
|
2022-10-24 21:03:53 +00:00
|
|
|
yarn install
|
2022-10-24 17:57:06 +00:00
|
|
|
```
|
2022-10-25 02:29:59 +00:00
|
|
|
|
2022-10-24 17:43:22 +00:00
|
|
|
- Run Metro
|
2022-10-25 02:29:59 +00:00
|
|
|
|
2022-10-24 17:43:22 +00:00
|
|
|
```
|
|
|
|
yarn start
|
|
|
|
```
|
|
|
|
|
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-24 19:58:26 +00:00
|
|
|
- [ ] i18n not loading
|
|
|
|
- [ ] Logging out and in again does not work
|
2022-10-24 20:15:33 +00:00
|
|
|
- [ ] Clipboard library not working
|
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-10-24 18:13:35 +00:00
|
|
|
- [ ] Infinite Load
|
2022-10-24 22:00:14 +00:00
|
|
|
- [ ] Go to replied event
|
2022-10-24 18:13:35 +00:00
|
|
|
- [ ] Relays management (add, remove and recomend)
|
|
|
|
- [ ] Random Key Generator
|
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-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-10-24 17:43:22 +00:00
|
|
|
- [ ] 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-10-25 02:29:59 +00:00
|
|
|
---
|
2022-10-24 17:43:22 +00:00
|
|
|
|
|
|
|
Made with 🐨 by https://getalby.com/p/koalasat
|