mirror of
https://github.com/RoboSats/robosats.git
synced 2025-07-17 08:13:19 +00:00
Dev docs
This commit is contained in:
16
README.md
16
README.md
@ -76,22 +76,8 @@ Alice wants to buy satoshis privately:
|
||||
11. The bonds would be charged (lost) in case of unilateral cancellation or cheating (lost dispute).
|
||||
|
||||
## Contribute to the Robotic Satoshis Open Source Project
|
||||
Check out our [Contribution Guide](https://learn.robosats.org/contribute/) to find how you can make RoboSats great.
|
||||
|
||||
RoboSats is a monorepo, arguably a messy one at the moment.
|
||||
- The top level is a Django application (the coordinator backend) with apps `/api`, `/control`, and `/chat`. Django settings are in `/robosats` and `/tests` has integration tests for the RoboSats backend.
|
||||
- The `/frontend` directory contains the ReactJS client.
|
||||
- The `/nodeapp` directory contains the docker orchestration and utilities for the self-hosted application (Umbrel, StartOS, etc). We also use this one in unsafe.robosats.org
|
||||
|
||||
- The `/mobile` directory contains our React Native app (a wrapper around our ReactJS app in `/frontend`)
|
||||
- The `/docs` directory has the learn.robosats.org static Jekyll site markdown docs.
|
||||
- The `/web` directory is a light wrapper around our client app `/frontend` intended to host a RoboSats dex client to be used for the public. Used for our official onion address.
|
||||
|
||||
You can run the whole stack for local development following the instructions in [setup.md](/setup.md)
|
||||
|
||||
Officially mantained docker orchestration for coordinators can be found in the repo [robosats-deploy](https://github.com/RoboSats/robosats-deploy)
|
||||
### ⚡Developer Rewards ⚡
|
||||
Check out the [Developer Rewards Panel](https://github.com/users/Reckless-Satoshi/projects/2/views/5) for tasks paid in Sats.
|
||||
Check [/development](/development)
|
||||
|
||||
## Sponsors
|
||||
<div align="center">
|
||||
|
@ -1 +1,25 @@
|
||||
# Development
|
||||
|
||||
Check out our [Contribution Guide](https://learn.robosats.org/contribute/) to find how you can make RoboSats great.
|
||||
|
||||
RoboSats is a monorepo, arguably a messy one at the moment.
|
||||
- The top level is a Django application (the coordinator backend) with apps `/api`, `/control`, and `/chat`. Django settings are in `/robosats` and `/tests` has integration tests for the RoboSats backend.
|
||||
- The `/frontend` directory contains the ReactJS client.
|
||||
- The `/nodeapp` directory contains the docker orchestration and utilities for the self-hosted application (Umbrel, StartOS, etc). We also use this one in unsafe.robosats.org
|
||||
|
||||
- The `/mobile` directory contains our React Native app (a wrapper around our ReactJS app in `/frontend`)
|
||||
- The `/docs` directory has the learn.robosats.org static Jekyll site markdown docs.
|
||||
- The `/web` directory is a light wrapper around our client app `/frontend` intended to host a RoboSats dex client to be used for the public. Used for our official onion address.
|
||||
|
||||
## Documentation
|
||||
|
||||
We always try to keep a hight level understanding of all involved workflows in coordinators and clients. Check [/docs.md](/docs.md)
|
||||
|
||||
## Start
|
||||
|
||||
You can run the whole stack for local development following the instructions in [setup.md](/setup.md)
|
||||
|
||||
Officially mantained docker orchestration for coordinators can be found in the repo [robosats-deploy](https://github.com/RoboSats/robosats-deploy)
|
||||
|
||||
## ⚡Developer Rewards ⚡
|
||||
Check out the [Developer Rewards Panel](https://github.com/users/Reckless-Satoshi/projects/2/views/5) for tasks paid in Sats.
|
||||
|
BIN
development/assets/federation.png
Normal file
BIN
development/assets/federation.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 252 KiB |
BIN
development/assets/garage.png
Normal file
BIN
development/assets/garage.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 503 KiB |
1
development/docs.md
Normal file
1
development/docs.md
Normal file
@ -0,0 +1 @@
|
||||
# Documentation
|
Reference in New Issue
Block a user