Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Request: Setup Instructions #1

Open
sneak opened this issue Feb 15, 2020 · 1 comment
Open

Documentation Request: Setup Instructions #1

sneak opened this issue Feb 15, 2020 · 1 comment

Comments

@sneak
Copy link

sneak commented Feb 15, 2020

I'd love to know how to get involved in this project, even if it's just running a p2p node. I'd also like to run a frontend for personal/private use.

I'm quite technical, so I'm happy to pitch in and write docs or a Dockerfile or other such. Is there a place you normally chat/collaborate?

@go1dfish
Copy link
Member

Thanks for the interest
Normally just in the notabug chat itself, dogfooding you know.

https://notabug.io/t/notabug/chat or just https://notabug.io/t/whatever/chat are good options

The system is best described as a federated system right now, running a node without telling others about it won't help the network on its own (aside from mirroring the content in the case of catastrophe on my part) but it will give you a local playground and if you tell others about your peer it will help to split the load.

The instructions here should be working:

https://github.com/notabugio/notabug#setup-instructions

Only tested on linux (and mac, but not recently)

Running that should give you a local peer running on localhost:4444 and the code in packages/notabug represents the UI

If you're primarily interested in UI dev your best bet is to cd into packages/notabug and run

"yarn uidev"

I don't have the process of running an indexer/tabulator documented yet because I'm working on an overhaul to that code to better support multiple cores/machines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants