From 1a46d072d7f8ed270cfbbed3eae95fba798e78b7 Mon Sep 17 00:00:00 2001 From: enigmalea Date: Fri, 17 Nov 2023 20:33:25 -0500 Subject: [PATCH 1/5] updates readme --- README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3509b503..7fb99b91 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# boba-frontend -Frontend for BobaBoard +# boba-frontend + +
+ +![CircleCI](https://img.shields.io/circleci/build/github/BobaBoard/boba-frontend?style=for-the-badge&logo=CircleCI) +![GitHub last commit](https://custom-icon-badges.demolab.com/github/last-commit/BobaBoard/boba-frontend?style=for-the-badge&color=c6a0f6&logo=git-commit) +![GitHub closed pull requests](https://custom-icon-badges.demolab.com/github/issues-pr-closed/BobaBoard/boba-frontend?style=for-the-badge&color=a6da95&logo=git-pull-request-closed) +![GitHub pull requests](https://custom-icon-badges.demolab.com/github/issues-pr-raw/BobaBoard/boba-frontend?style=for-the-badge&color=f0c6c6&logo=git-pull-request) +[![Open issues](https://custom-icon-badges.demolab.com/github/issues/BobaBoard/boba-frontend?style=for-the-badge&color=91d7e3&logo=issue-opened)](https://github.com/BobaBoard/boba-frontend/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) + +
+ +## BobaBoard + +A short blurb on what BobaBoard is. This should be the same on all our repos. We +should link to bobaboard.com here, I think, and maybe the project section of the +docs, too. + +## This Repo + +![Built Using](https://img.shields.io/badge/Built%20Using:-222222?style=for-the-badge) +![TypeScript Badge](https://img.shields.io/badge/TypeScript-222222?logo=typescript&logoColor=3178C6&style=for-the-badge) +![React Badge](https://img.shields.io/badge/React-222222?logo=react&logoColor=61DAFB&style=for-the-badge) +![Node.js Badge](https://img.shields.io/badge/Node.js-222222?logo=nodedotjs&logoColor=393&style=for-the-badge) + +A short blurb about this specific repo. What is it? What does it do? We should link to the boba-docs section for this repo. + +## Local Development + +A short blurb and link to boba-docs installation for this repo. + +## Contributing + +Links to relevant Contrib & Volunteer Docs on boba-docs. Probably the same on all +repos. + +## License + +![GitHub](https://img.shields.io/github/license/BobaBoard/boba-frontend?style=for-the-badge&color=A41931) From 2e7f0d06dc72a03db1d1be240efc254dcf52349d Mon Sep 17 00:00:00 2001 From: enigmalea Date: Sat, 23 Dec 2023 18:22:34 -0500 Subject: [PATCH 2/5] updates readme. --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7fb99b91..0413e124 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,17 @@ ## BobaBoard -A short blurb on what BobaBoard is. This should be the same on all our repos. We -should link to bobaboard.com here, I think, and maybe the project section of the -docs, too. +BobaBoard is a modern, open source community-building software that draws +inspiration from old-school forums for functionality and from modern social +media for its style of interaction. It prioritizes privacy and fluidity of +identity for users within communities and allows high levels of customization +and fine-grained permission settings for users, community managers, and instance +owners. The unique UX encourages creative expression across different formats, +styles of communication, and community building. + +You can find out more about BobaBoard in general on our +[website](https://www.bobaboard.com) and as a project by visiting our +[project guide](https://docs.bobaboard.com/docs/project/intro). ## This Repo @@ -22,17 +30,31 @@ docs, too. ![TypeScript Badge](https://img.shields.io/badge/TypeScript-222222?logo=typescript&logoColor=3178C6&style=for-the-badge) ![React Badge](https://img.shields.io/badge/React-222222?logo=react&logoColor=61DAFB&style=for-the-badge) ![Node.js Badge](https://img.shields.io/badge/Node.js-222222?logo=nodedotjs&logoColor=393&style=for-the-badge) +![Yarn Badge](https://img.shields.io/badge/Yarn-222222?logo=yarn&logoColor=2C8EBB&style=for-the-badge) + +boba-frontend is the repo which controls the main layout, design, and user-facing interactions for BobaBoard. + +### Relationships To Other Repos + +Boba-frontend requires [boba-backend](https://github.com/BobaBoard/boba-backend) to function as it queries the backend for user, thread, and post states. + +[Boba-components](https://github.com/BobaBoard/boba-components) provides boba-frontend with its UI pieces. -A short blurb about this specific repo. What is it? What does it do? We should link to the boba-docs section for this repo. ## Local Development -A short blurb and link to boba-docs installation for this repo. +For detailed instructions on how to develop for BobaBoard, please check out the links below: + +- [Setup Your Development Environment](https://docs.bobaboard.com/docs/development/start-developing/setting-up-dev-env) +- [How to Install WSL](https://docs.bobaboard.com/docs/development/start-developing/wsl) (Windows Only) +- [Install Boba-Frontend](https://docs.bobaboard.com/docs/development/start-developing/boba-frontend) + ## Contributing -Links to relevant Contrib & Volunteer Docs on boba-docs. Probably the same on all -repos. +BobaBoard welcomes one-time contributions. Our volunteer [Code of Conduct](https://docs.bobaboard.com/docs/volunteering/experience/code-of-conduct) applies in all of our social spaces, including Github Discussions or when commenting on issues or pull requests. + +We are also always looking for long-term volunteers to help with coding, documentation, and other efforts. If you'd like to become a BobaBoard volunteer, please see the [Volunteering Guide](https://docs.bobaboard.com/docs/volunteering) for details. ## License From 7f7a9600a217e02baea7837b7862ca4786cebdd2 Mon Sep 17 00:00:00 2001 From: enigmalea Date: Sat, 23 Dec 2023 19:33:49 -0500 Subject: [PATCH 3/5] corrects alt text for license badge. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0413e124..fdce13ae 100644 --- a/README.md +++ b/README.md @@ -58,4 +58,4 @@ We are also always looking for long-term volunteers to help with coding, documen ## License -![GitHub](https://img.shields.io/github/license/BobaBoard/boba-frontend?style=for-the-badge&color=A41931) +![MIT License](https://img.shields.io/github/license/BobaBoard/boba-frontend?style=for-the-badge&color=A41931) From 27cf1520e877e9c1e2284720dbc730967b6d4a4f Mon Sep 17 00:00:00 2001 From: enigmalea Date: Tue, 26 Dec 2023 19:04:03 -0500 Subject: [PATCH 4/5] resolved PR issues. --- README.md | 42 ++++++++++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fdce13ae..9a44636e 100644 --- a/README.md +++ b/README.md @@ -29,32 +29,54 @@ You can find out more about BobaBoard in general on our ![Built Using](https://img.shields.io/badge/Built%20Using:-222222?style=for-the-badge) ![TypeScript Badge](https://img.shields.io/badge/TypeScript-222222?logo=typescript&logoColor=3178C6&style=for-the-badge) ![React Badge](https://img.shields.io/badge/React-222222?logo=react&logoColor=61DAFB&style=for-the-badge) -![Node.js Badge](https://img.shields.io/badge/Node.js-222222?logo=nodedotjs&logoColor=393&style=for-the-badge) +![React Query Badge](https://img.shields.io/badge/React%20Query-222222?logo=reactquery&logoColor=FF4154&style=for-the-badge) +![Playwright Badge](https://img.shields.io/badge/Playwright-222222?logo=playwright&logoColor=2EAD33&style=for-the-badge) +![Next.js Badge](https://img.shields.io/badge/Next.js-222222?logo=nextdotjs&logoColor=fff&style=for-the-badge) ![Yarn Badge](https://img.shields.io/badge/Yarn-222222?logo=yarn&logoColor=2C8EBB&style=for-the-badge) -boba-frontend is the repo which controls the main layout, design, and user-facing interactions for BobaBoard. +boba-frontend handles the interactions of our UI with the server, lays out the +pages that BobaBoard is made of, and supplies the functionality of those pages. ### Relationships To Other Repos -Boba-frontend requires [boba-backend](https://github.com/BobaBoard/boba-backend) to function as it queries the backend for user, thread, and post states. +Boba-frontend requires [boba-backend](https://github.com/BobaBoard/boba-backend) +to function as it queries the backend for user, thread, and post states. -[Boba-components](https://github.com/BobaBoard/boba-components) provides boba-frontend with its UI pieces. +[Boba-components](https://github.com/BobaBoard/boba-components) provides +boba-frontend with its UI pieces primarily impacting the design of the UI. +> [!NOTE] The above description is an "aspirational state" for our repos and we +> are still working on defining what the boundaries between "Boba-frontend" and +> "boba-components" is so this may be fuxxy in practice. ## Local Development -For detailed instructions on how to develop for BobaBoard, please check out the links below: +For detailed instructions on how to develop for BobaBoard, please check out the +links below: - [Setup Your Development Environment](https://docs.bobaboard.com/docs/development/start-developing/setting-up-dev-env) -- [How to Install WSL](https://docs.bobaboard.com/docs/development/start-developing/wsl) (Windows Only) +- [How to Install WSL](https://docs.bobaboard.com/docs/development/start-developing/wsl) + (Windows Only) - [Install Boba-Frontend](https://docs.bobaboard.com/docs/development/start-developing/boba-frontend) - ## Contributing -BobaBoard welcomes one-time contributions. Our volunteer [Code of Conduct](https://docs.bobaboard.com/docs/volunteering/experience/code-of-conduct) applies in all of our social spaces, including Github Discussions or when commenting on issues or pull requests. - -We are also always looking for long-term volunteers to help with coding, documentation, and other efforts. If you'd like to become a BobaBoard volunteer, please see the [Volunteering Guide](https://docs.bobaboard.com/docs/volunteering) for details. +> [!Important] Our issue tracker is not up-to-date and we are specifically +> looking for people to help us wrangle issues into order. If you're very eager +> to start working, please contact us through our +> [tech form](https://docs.google.com/forms/d/e/1FAIpQLSdCX2_fZgIYX0PXeCAA-pfQrcLw_lSp2clGHTt3uBTWgnwVSw/viewform) +> (for coding) or our [non-tech form](https://forms.gle/Z44UreTxnbvFnoqc9) (for +> issue wrangling). + +BobaBoard welcomes one-time contributions. Our volunteer +[Code of Conduct](https://docs.bobaboard.com/docs/volunteering/experience/code-of-conduct) +applies in all of our social spaces, including Github Discussions or when +commenting on issues or pull requests. + +We are also always looking for long-term volunteers to help with coding, +documentation, and other efforts. If you'd like to become a BobaBoard volunteer, +please see the +[Volunteering Guide](https://docs.bobaboard.com/docs/volunteering) for details. ## License From 88d0cb471278edee985e1d82a6a71b8fb3fa387b Mon Sep 17 00:00:00 2001 From: enigmalea Date: Tue, 26 Dec 2023 19:06:44 -0500 Subject: [PATCH 5/5] correcting github admonition formatting. --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9a44636e..9ad67f54 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,8 @@ to function as it queries the backend for user, thread, and post states. [Boba-components](https://github.com/BobaBoard/boba-components) provides boba-frontend with its UI pieces primarily impacting the design of the UI. -> [!NOTE] The above description is an "aspirational state" for our repos and we -> are still working on defining what the boundaries between "Boba-frontend" and -> "boba-components" is so this may be fuxxy in practice. +> [!NOTE] +> The above description is an "aspirational state" for our repos and we are still working on defining what the boundaries between "boba-frontend" and "boba-components" is so this may be fuzzy in practice. ## Local Development @@ -61,12 +60,8 @@ links below: ## Contributing -> [!Important] Our issue tracker is not up-to-date and we are specifically -> looking for people to help us wrangle issues into order. If you're very eager -> to start working, please contact us through our -> [tech form](https://docs.google.com/forms/d/e/1FAIpQLSdCX2_fZgIYX0PXeCAA-pfQrcLw_lSp2clGHTt3uBTWgnwVSw/viewform) -> (for coding) or our [non-tech form](https://forms.gle/Z44UreTxnbvFnoqc9) (for -> issue wrangling). +> [!Important] +> Our issue tracker is not up-to-date and we are specifically looking for people to help us wrangle issues into order. If you're very eager to start working, please contact us through our [tech form](https://docs.google.com/forms/d/e/1FAIpQLSdCX2_fZgIYX0PXeCAA-pfQrcLw_lSp2clGHTt3uBTWgnwVSw/viewform) (for coding) or our [non-tech form](https://forms.gle/Z44UreTxnbvFnoqc9) (for issue wrangling). BobaBoard welcomes one-time contributions. Our volunteer [Code of Conduct](https://docs.bobaboard.com/docs/volunteering/experience/code-of-conduct)