nostros/README.md

64 lines
1.9 KiB
Markdown
Raw Normal View History

2022-10-24 17:43:22 +00:00
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/db3100f978a542d588f8ae9a4abf2d55)](https://www.codacy.com/gh/KoalaSat/sats-4-likes-bot/dashboard?utm_source=github.com&utm_medium=referral&utm_content=KoalaSat/sats-4-likes-bot&utm_campaign=Badge_Grade)
[![MIT license](https://img.shields.io/badge/license-MIT-green)](https://github.com/KoalaSat/sats-4-likes-bot/blob/main/LICENSE)
![nostros_logo](https://user-images.githubusercontent.com/111684255/197588983-2a196d74-0f1e-45e8-be56-0da8c1602835.png)
Wellcome to the NOSTROS project.
2022-10-24 17:47:25 +00:00
# Getting Started
2022-10-24 17:43:22 +00:00
2022-10-24 17:47:25 +00:00
## Required Libraries and Framworks
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
```
yarn format
```
2022-10-24 17:43:22 +00:00
- Run Metro
```
yarn start
```
2022-10-24 17:47:25 +00:00
# Some Features to Work On
2022-10-24 19:58:26 +00:00
### Bugs
- [ ] User info missing on first start
- [ ] 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-24 18:14:04 +00:00
### Basics
2022-10-24 18:13:35 +00:00
- [ ] Infinite Load
- [ ] Relays management (add, remove and recomend)
- [ ] Random Key Generator
2022-10-24 18:14:04 +00:00
### Home
2022-10-24 17:43:22 +00:00
- [ ] Public Room
- [ ] Other Rooms
2022-10-24 18:14:04 +00:00
### Profile
2022-10-24 17:43:22 +00:00
- [ ] Verify NIP-05
- [ ] Verify LNURL https://github.com/andrerfneves/lightning-address
2022-10-24 18:14:04 +00:00
### Contacts
2022-10-24 17:43:22 +00:00
- [ ] Direct Messages https://github.com/nostr-protocol/nips/blob/master/04.md
2022-10-24 18:14:04 +00:00
### Note
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-24 18:14:04 +00:00
### Send
2022-10-24 17:43:22 +00:00
- [ ] Mentions https://github.com/nostr-protocol/nips/blob/master/08.md
2022-10-24 18:14:04 +00:00
### Config
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-24 17:43:22 +00:00
------
Made with 🐨 by https://getalby.com/p/koalasat