diff --git a/README.md b/README.md index 936377c7..de039796 100644 --- a/README.md +++ b/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
diff --git a/development/README.md b/development/README.md index 459110d3..e5867587 100644 --- a/development/README.md +++ b/development/README.md @@ -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. diff --git a/development/assets/federation.png b/development/assets/federation.png new file mode 100644 index 00000000..464a6b08 Binary files /dev/null and b/development/assets/federation.png differ diff --git a/development/assets/garage.png b/development/assets/garage.png new file mode 100644 index 00000000..cda57568 Binary files /dev/null and b/development/assets/garage.png differ diff --git a/development/docs.md b/development/docs.md new file mode 100644 index 00000000..7d8b3af5 --- /dev/null +++ b/development/docs.md @@ -0,0 +1 @@ +# Documentation \ No newline at end of file diff --git a/RELEASE.md b/development/release.md similarity index 100% rename from RELEASE.md rename to development/release.md diff --git a/setup.md b/development/setup.md similarity index 100% rename from setup.md rename to development/setup.md