Merge readme and improved setup before Learn.RoboSats WIP release

This commit is contained in:
Reckless_Satoshi 2022-05-18 18:02:05 -07:00
commit 5f17a1608b
No known key found for this signature in database
GPG Key ID: 9C4585B561315571
8 changed files with 40 additions and 10 deletions

View File

@ -25,11 +25,11 @@ RoboSats is a simple and private way to exchange bitcoin for national currencies
## How to use it
- **[Full Walkthrough how to use RoboSats (English)](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/how-to-use.md)**
- **[Full Walkthrough how to use RoboSats (English)](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/tutorials/read/how-to-use.md)**
- **[Guia completa de como usar RoboSats (Español)](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/how-to-use_es.md)**
- **[Guia completa de como usar RoboSats (Español)](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/tutorials/read/how-to-use_es.md)**
- **[Vollständiges how to use RoboSats (German)](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/how-to-use_de.md)**
- **[Vollständiges how to use RoboSats (German)](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/tutorials/read/how-to-use_de.md)**
**Short video-walktrough**

View File

@ -50,6 +50,8 @@ docs:
url: /docs/limits/
- title: "<span>&nbsp; &thinsp;<i class='fa-solid fa-arrow-right-arrow-left'></i> Swaps</span>"
url: /docs/swaps/
- title: "<span>&nbsp; &thinsp;<i class='fa-brands fa-telegram'></i> Telegram</span>"
url: /docs/telegram/
- title: "<i class='fa-solid fa-hand-peace'></i> Best Practices"
url: /docs/best-practices/

View File

@ -1,6 +1,6 @@
## <i class="fa-brands fa-github-alt"></i> You can create and add here more tutorials
## <i class="fa-brands fa-github-alt"></i> You can add here more tutorials
Learn RoboSats is a joint effort of the RoboSats community. If you have used RoboSats before, you are already an expert! Help us build more and better tutorials in all languages.
Learn RoboSats is a joint effort of the RoboSats community. If you have used RoboSats before, you are already an expert! Help us build more and better tutorials in every language.
**ProTip:** You can directly [edit this page <i class="fa-brands fa-github-alt"></i>](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/{{page.src}}) and open a [Pull Request <i class="fa-solid fa-code-pull-request"/>](https://github.com/Reckless-Satoshi/robosats/pulls). Your changes will show right here.
{: .notice--primary}

View File

@ -3,9 +3,18 @@ layout: single
title: "Donate"
permalink: /contribute/donate/
sidebar:
title: "<i class='fa-solid fa-bitcoin'></i> Donate"
title: "<i class='fa-brands fa-bitcoin'></i> Donate"
nav: contribute
src: "_pages/contribute/07-donate.md"
---
<!-- We do not think RoboSats should rely on donations in order to stay active. Your best way to donate to RoboSats is to actively make use of the platform and tell your friends.
We do however, appreciate donations, since the platform runs at a loss at the moment and development is hard to fund.
You can donate by:
1. Directly tipping the developer working on the features you like. Check the active PRs and show your support to the community developers with Lightning Tips
2. Via KeySend to RoboSats node: (linked to Node ID)
3. Via an on-chain transaction to: ADDRESS (address tied to RoboSats LN node funding wallet) -->
{% include wip %}

View File

@ -23,6 +23,7 @@ thumbsdown: "<i style='color:#9c27b0' class='fa-solid fa-thumbs-down fa-2xl'></i
unclear: "<i style='color:#ff9800' class='fa-solid fa-question fa-2xl'></i>"
bitcoin: "<i class='fa-solid fa-bitcoin-sign'></i>"
---
This is a non-exhaustive compilation based on past experience of users. We have not tested every wallet, if you test a wallet that is not yet covered, please [report here](https://github.com/Reckless-Satoshi/robosats/issues/44).
| Wallet | Version | Device | UX<sup>1</sup> | Bonds<sup>2</sup> | Payout<sup>3</sup> | Comp<sup>4</sup> | Total<sup>5</sup> |
|:---|:---|:--:|:--:|:--:|:--:|:--:|:--:|

View File

@ -0,0 +1,13 @@
---
layout: single
title: Telegram Notifications, Alert and Groups
permalink: /docs/telegram/
sidebar:
title: "<i class='fa-brands fa-telegram'></i> Telegram"
nav: docs
src: "_pages/docs/03-understand/10-telegram.md"
---
<!-- Cover: telegram notification bot: how to enable (on phone and desktop). What are the privacy trade offs. Alert bot (Jacky). Telegram public support group, different language group. Warning: never reply to privates. Never share your robot token -->
{% include wip %}

View File

@ -2,7 +2,7 @@
layout: home
author_profile: true
title: "Welcome to Learn.RoboSats!"
date: 2022-05-19 06:28:14 -0500
date: 2022-05-18 06:28:14 -0500
categories: robosats update
---
Sovereignty is scary at first, then liberating. Buying your first Sats from a peer might seem intimidating, but it is very empowering. In Learn.RoboSats you can find all of the documentation and resources so you feel comfortable using the RoboSats P2P exchange. From easy to follow video tutorials, to technical deep-dives into how the exchange works.

View File

@ -19,19 +19,24 @@ Running the full stack is not easy, since RoboSats needs of many services. Howev
4 - On another terminal `npm install -g http-server`
5 - Then run `http-server "robosats/frontend/static/frontend/`
5 - Then run `http-server "robosats/frontend/static/`
6 - Install [Requestly](https://requestly.io/) extension in your browser, it's a lightweight proxy. We want to use it so our browser grabs our local `main.js` instead of the remote. There are many alternatives to Requestly (be aware that Requestly might not respect your privacy. Didn't research it).
7 - Pick a RoboSats backend to test the new frontend: e.g. "robosats.onion.moe", or "unsafe.testnet.robosats.com". You can also use the onion services also if you are using Brave or Tor Browser (untested!)
8 - Open Requestly extension and add a new redirect rule. Make "{robosats-site}/static/frontend/main.js" redirect to "127.0.0.1:8080/main.js" and save the changes.
8 - Open Requestly extension and add a new redirect rule. Make "{robosats-site}/static/frontend/main.js" redirect to "127.0.0.1:8080/frontend/main.js" and save the changes.
-------------------
**You are ready to go!** Edit the frontend code in `/frontend/src/` to make the changes you want. Within a few seconds, the `npm run dev` process will pack the code into the local `main.js`. Visit your selected {robosats-site} and you will see your new awesome frontend! :)
Every time you save changes to files in `/frontend/src` you will be able to see them in your browser after a few seconds using force refresh (Ctrl+Shift+R). If you need to edit CSS or other static files, simply add them to Requestly in the same way.
Every time you save changes to files in `/frontend/src` you will be able to see them in your browser after a few seconds using force refresh (Ctrl+Shift+R).
If you need to edit CSS or other static files in `/frontend/static`, simply add them to Requestly in the same way.
i.e: index.css
Make "{robosats-site}/static/css/index.css" redirect to "127.0.0.1:8080/css/index.css"
# Full Stack Development
## The Easy Way: Docker-compose (-dev containers running on testnet)