Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BrightonBTC/bija
https://github.com/BrightonBTC/bija
nostr
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/BrightonBTC/bija
- Owner: BrightonBTC
- License: mit
- Archived: true
- Created: 2022-11-07T18:27:17.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-27T12:43:33.000Z (over 1 year ago)
- Last Synced: 2024-08-04T11:01:16.088Z (4 months ago)
- Topics: nostr
- Language: Python
- Homepage:
- Size: 1.52 MB
- Stars: 67
- Watchers: 4
- Forks: 16
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-nostr - Bija - A desktop client written in python. Currently Linux only (Clients / Relay lists)
README
# Please note that this project is no longer being maintained:
I'm still working on some Nostr based projects but made the decision to end development on this. Many other Twitter style apps exist on Nostr now so please choose one of those instead. Thanks.
# Bija Nostr Client
Python [Nostr](https://github.com/nostr-protocol/nostr) client with backend that runs on a local flask server, and front end in your browser
*nb. earlier versions of Bija opened a Qt window. That's not currently available, you can only load the UI in a browser at this time.*
This is experimental software in early development and comes without warranty.
### Native Setup :snake:
If you want to give it a test run you can find early releases for Linux (Windows and OSX versions intended at a later date) on the [releases page](https://github.com/BrightonBTC/bija/releases)
Or, to get it up and running yourself:
```
git clone https://github.com/BrightonBTC/bija
cd bija
pip install -r ./requirements.txt
python3 cli.py
```
*nb. requires python3.10+*
You can now access bija at http://localhost:5000
In the event that something else is running on port 5000 you can pass `--port XXXX` to cli.py and if you want to use/create a different db, for example if you want to manage multiple accounts then use `--db name` (default is called bija)
eg.
```
python3 cli.py --port 5001 --db mydb
```
Or additionally to the above you could compile using pyinstaller:
* This should theoretically also work for OSX but is untested (please let me know if you have success!). Bija currently has some dependencies that are incompatible with Windows though.
```
pyinstaller cli.py --onefile -w -F --add-data "bija/templates:bija/templates" --add-data "bija/static:bija/static" --name "bija-nostr-client"
```
### Docker Setup :whale2:
To setup Bija with docker, first clone the project:
```
git clone https://github.com/BrightonBTC/bija
cd bija
```
Then just run docker-compose up and access Bija through the browser
```
docker-compose up
```
You can now access bija at http://localhost:5000
Enjoy :grinning: