Code Monkey home page Code Monkey logo

bija's Introduction

Bija Nostr Client

Python 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 ๐Ÿ

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

Or, to get it up and running yourself:

git clone --recurse-submodules 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 ๐Ÿ‹

To setup Bija with docker, first clone the project:

git clone --recurse-submodules https://github.com/BrightonBTC/bija
cd bija

Warning If you don't clone with --recurse-submodules, you must run git submodules update

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 ๐Ÿ˜€

bija's People

Contributors

brightonbtc avatar julianpedro avatar makinthestuff avatar odudex avatar secondl1ght avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.