From 26189d623b9c4cc19b1c948ceaa4a313284ec2a6 Mon Sep 17 00:00:00 2001 From: Sandino Scheidegger Date: Mon, 3 Feb 2025 16:59:58 +0100 Subject: [PATCH] DevOp: Small Readme update (#1039) * Small update * Prettified Code! --------- Co-authored-by: ssandino --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index dea2dbbd4..5e4d4905c 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,16 @@ https://user-images.githubusercontent.com/6095849/191377786-10cdb4a1-5b25-4512-a ## OSS Tools by Social Income -| | Admin Tool | Website | Mobile App | -| ---------------- | :-------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| | ![](https://github.com/socialincome-san/public/assets/6095849/42a8ce3e-4ff3-4d25-a298-1b4bc1570b0a) | ![](https://github.com/socialincome-san/public/assets/6095849/e4dbf692-d4b9-4253-88ea-2da7970919d8) | ![](https://github.com/socialincome-san/public/assets/6095849/94d0f653-d894-4e9e-ab0d-b1cd8bfe9eab) | -| **Purpose** | Make it simple to manage payments, contributors and recipients | Raising donations and inform the public | Make it simple for recipients to manage payments and surveys | -| **Instructions** | [Readme](admin/README.md) | [Readme](website/README.md) | [Readme](recipients_app/README.md) / [Contributing](recipients_app/CONTRIBUTING.md) | -| **Localhost** | [localhost:3000](http://localhost:3000) / [4000](http://localhost:4000) | [localhost:3001](http://localhost:3001) | – | -| **Staging** | [staging-admin.socialincome.org](https://staging-admin.socialincome.org) | [staging.socialincome.org](https://staging.socialincome.org/) | [Testflight](https://developer.apple.com/testflight/) / [App Distribution](https://firebase.google.com/docs/app-distribution) | -| **Production** | [admin.socialincome.org](https://admin.socialincome.org) | [socialincome.org](https://socialincome.org) | [iOS](https://apps.apple.com/ch/app/social-income/id6444860109?l=en-GB) / [Android](https://play.google.com/store/apps/details?id=org.socialincome.app&pcampaignid=web_share) | -| **Issues** | [Open issues](https://github.com/socialincome-san/public/issues?q=is%3Aissue+is%3Aopen+label%3Aadmintool) | [Open issues](https://github.com/socialincome-san/public/issues?q=is%3Aissue+is%3Aopen+label%3Awebsite) | [Open issues](https://github.com/socialincome-san/public/issues?q=is%3Aissue+is%3Aopen+label%3Amobileapp) | -| **UI Kit** | – | [UI Components Documentation](https://socialincome-san.github.io/public/) | – | +| | Admin Tool | Website | Mobile App | +| ---------------- | :-------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| | ![](https://github.com/socialincome-san/public/assets/6095849/42a8ce3e-4ff3-4d25-a298-1b4bc1570b0a) | ![](https://github.com/socialincome-san/public/assets/6095849/e4dbf692-d4b9-4253-88ea-2da7970919d8) | ![](https://github.com/socialincome-san/public/assets/6095849/94d0f653-d894-4e9e-ab0d-b1cd8bfe9eab) | +| **Purpose** | Make it simple to manage payments, contributors and recipients | Raising donations and inform the public | Make it simple for recipients to manage payments and surveys | +| **Instructions** | [Readme](admin/README.md) | [Readme](website/README.md) | [Readme](recipients_app/README.md) / [Contributing](recipients_app/CONTRIBUTING.md) | +| **Localhost** | [localhost:3000](http://localhost:3000) / [4000](http://localhost:4000) | [localhost:3001](http://localhost:3001) | – | +| **Staging** | [staging-admin.socialincome.org](https://staging-admin.socialincome.org) | [staging.socialincome.org](https://staging.socialincome.org/) | [Testflight](https://developer.apple.com/testflight/) / [App Distribution](https://firebase.google.com/docs/app-distribution) | +| **Production** | [admin.socialincome.org](https://admin.socialincome.org) | [socialincome.org](https://socialincome.org) | [iOS](https://apps.apple.com/ch/app/social-income/id6444860109?l=en-GB) / [Android](https://play.google.com/store/apps/details?id=org.socialincome.app&pcampaignid=web_share) | +| **Issues** | [Open issues](https://github.com/socialincome-san/public/issues?q=is%3Aissue+is%3Aopen+label%3Aadmintool) | [Open issues](https://github.com/socialincome-san/public/issues?q=is%3Aissue+is%3Aopen+label%3Awebsite) | [Open issues](https://github.com/socialincome-san/public/issues?q=is%3Aissue+is%3Aopen+label%3Amobileapp) | +| **UI Library** | – | [Storybook](http://design.socialincome.org/) / [Figma]() | – | # Code Contributions @@ -46,7 +46,8 @@ https://user-images.githubusercontent.com/6095849/191377786-10cdb4a1-5b25-4512-a [shadcn/ui](https://ui.shadcn.com) independent of the website ([Readme](ui/README.md) / [Contributing](ui/CONTRIBUTING.md)). The components are all collected in our -[Storybook](https://socialincome-san.github.io/public/). +[Storybook](http://design.socialincome.org/) and +[Figma file](). ### Basic Development Setup