mirror of
https://github.com/RoboSats/robosats.git
synced 2024-08-17 01:40:39 +03:00
chore: explain monorepo architecture on readme.md
This commit is contained in:
parent
eb1060d3a6
commit
7375e1dfb3
11
README.md
11
README.md
@ -53,6 +53,17 @@ Alice wants to buy satoshis privately:
|
|||||||
## Contribute to the Robotic Satoshis Open Source Project
|
## Contribute to the Robotic Satoshis Open Source Project
|
||||||
Check out our [Contribution Guide](https://learn.robosats.com/contribute/) to find how you can make RoboSats great.
|
Check out our [Contribution Guide](https://learn.robosats.com/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)
|
||||||
|
- The `/mobile` directory contains our React Native app (a wrapper around our ReactJS app in `/frontend`)
|
||||||
|
- The `/docs` directory has the learn.robosats.com 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. We use this one in dex.robosats.com
|
||||||
|
|
||||||
|
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 ⚡
|
### ⚡Developer Rewards ⚡
|
||||||
Check out the [Developer Rewards Panel](https://github.com/users/Reckless-Satoshi/projects/2/views/5) for tasks paid in Sats.
|
Check out the [Developer Rewards Panel](https://github.com/users/Reckless-Satoshi/projects/2/views/5) for tasks paid in Sats.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user