From 8370a6970a6aa39be0ac7b02e42baff7d5585e76 Mon Sep 17 00:00:00 2001 From: Sahil Davkhar <141304285+Sahildavkhar@users.noreply.github.com> Date: Mon, 6 Oct 2025 17:55:02 +0530 Subject: [PATCH 1/6] Update README.md --- README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 56 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1e9b3160..bc8e719c 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,13 @@ A better way to build headless WordPress applications. - [Overview](#what-is-snapwp) - [What's Included?](#whats-included) - [Usage](#usage) -- [Development & Contributing](#local-development--contributing-guidelines) +- [Local Setup Guide](#local-setup-guide) +- [Development & Contributing](#development--contributing) +- [Community & Support](#community--support) - [License](#license) +--- + ## What is SnapWP? [SnapWP](https://snapwp.io) is a composable framework of JavaScript libraries for building headless WordPress applications. @@ -24,6 +28,8 @@ SnapWP treats headless WordPress as a progressive enhancement, providing a "turn > ๐Ÿ‰ There be dragons! > This project is in **active development** and considered _experimental_. Some features may be incomplete, unstable, or subject to change. +--- + ## What's Included? SnapWP provides several plugins, packages, and libraries that can be used individually or together to build better headless WordPress applications. @@ -43,12 +49,14 @@ SnapWP provides several plugins, packages, and libraries that can be used indivi - [@snapwp/codegen-config](packages/codegen-config): Reusable configuration for [GraphQL Codegen](https://the-guild.dev/graphql/codegen). - [@snapwp/eslint-config](packages/eslint-config): Reusable ESLint configuration. -- [@snapwp/prettier-config](packages/jest-preset): Reusable Prettier configuration. +- [@snapwp/prettier-config](packages/prettier-config): Reusable Prettier configuration. ### WordPress Plugins (๐Ÿ”Œ External) - [SnapWP Helper](https://github.com/rtCamp/snapwp-helper): A WordPress plugin that provides the additional functionality to WordPress and [WPGraphQL](https://www.wpgraphql.com/) needed for SnapWP's frontend libraries. +--- + ## Usage - [Getting Started](docs/getting-started.md) @@ -65,18 +73,56 @@ SnapWP provides several plugins, packages, and libraries that can be used indivi - [NextJS Middleware](docs/middleware.md) - [Static Exports](docs/static-exports.md) -## Development & Contributing +--- + +## ๐Ÿง‘โ€๐Ÿ’ป Local Setup Guide + +Follow these steps to run SnapWP locally for development or experimentation: + +1. **Fork and clone the repository** + ``` + git clone https://github.com//snapwp.git + cd snapwp +3. **Start the development server** +npm run dev + +This runs the local environment (usually on http://localhost:3000). + +3. **Connect to a WordPress backend** + +Install and activate the WPGraphQL plugin + +Add this line to your .env.local file: +NEXT_PUBLIC_WP_API_URL=https://your-site.com/graphql -[SnapWP](https://github.com/rtCamp/snapwp) is under active development and maintained by [rtCamp](https://rtcamp.com/). +4. **Explore available packages** +Package Description +@snapwp/core Core utilities +@snapwp/next Next.js integration +@snapwp/blocks WordPress block rendering +@snapwp/query GraphQL query manager -Contributions are _welcome_ and **encouraged!** To learn more about contributing to SnapWP, please read the [Contributing Guide](/.github/CONTRIBUTING.md). +๐Ÿงฉ **Development & Contributing** +SnapWP is under active development and maintained by rtCamp. -For development guidelines, please refer to our [Development Guide](./DEVELOPMENT.md). +Contributions are welcome and encouraged! ๐Ÿ’ช +You can: +Add new modules +Improve documentation +Optimize existing components +Fix bugs or issues -## License +To learn more about contributing, please read the Contributing Guide +For development standards, check the Development Guide -This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details. +๐Ÿ’ฌ **Community & Support** +If you have questions, ideas, or issues: +Check out the Issues section. +Start a discussion or suggest improvements. +Follow rtCamp on GitHub for updates. -## BTW, We're Hiring! +๐Ÿงพ **License** +This project is licensed under the AGPL-3.0 License โ€” see the LICENSE file for details. -Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions +๐Ÿ’ผ BTW, We're Hiring! + Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions From bdf07b4a417d600082be247fe2ea81b7af661c6e Mon Sep 17 00:00:00 2001 From: Sahil Davkhar <141304285+Sahildavkhar@users.noreply.github.com> Date: Mon, 6 Oct 2025 17:57:31 +0530 Subject: [PATCH 2/6] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc8e719c..4d0e9114 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Follow these steps to run SnapWP locally for development or experimentation: git clone https://github.com//snapwp.git cd snapwp 3. **Start the development server** -npm run dev +```npm run dev``` This runs the local environment (usually on http://localhost:3000). @@ -93,7 +93,9 @@ This runs the local environment (usually on http://localhost:3000). Install and activate the WPGraphQL plugin Add this line to your .env.local file: +``` NEXT_PUBLIC_WP_API_URL=https://your-site.com/graphql +``` 4. **Explore available packages** Package Description From 807a0c4df4b4dae3108c0aa3bb9c86df905fcce2 Mon Sep 17 00:00:00 2001 From: Sahil Davkhar <141304285+Sahildavkhar@users.noreply.github.com> Date: Mon, 6 Oct 2025 17:59:00 +0530 Subject: [PATCH 3/6] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4d0e9114..9226c217 100644 --- a/README.md +++ b/README.md @@ -98,11 +98,11 @@ NEXT_PUBLIC_WP_API_URL=https://your-site.com/graphql ``` 4. **Explore available packages** -Package Description -@snapwp/core Core utilities -@snapwp/next Next.js integration -@snapwp/blocks WordPress block rendering -@snapwp/query GraphQL query manager +Package Description
+@snapwp/core Core utilities
+@snapwp/next Next.js integration
+@snapwp/blocks WordPress block rendering
+@snapwp/query GraphQL query manager
๐Ÿงฉ **Development & Contributing** SnapWP is under active development and maintained by rtCamp. From f95e05f7117681a892ab8dd1c8898a34b3e9bc02 Mon Sep 17 00:00:00 2001 From: Sahil Davkhar <141304285+Sahildavkhar@users.noreply.github.com> Date: Mon, 6 Oct 2025 18:00:03 +0530 Subject: [PATCH 4/6] Update README.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 9226c217..87b3a2b8 100644 --- a/README.md +++ b/README.md @@ -104,27 +104,27 @@ Package Description
@snapwp/blocks WordPress block rendering
@snapwp/query GraphQL query manager
-๐Ÿงฉ **Development & Contributing** -SnapWP is under active development and maintained by rtCamp. +๐Ÿงฉ **Development & Contributing**
+SnapWP is under active development and maintained by rtCamp.
-Contributions are welcome and encouraged! ๐Ÿ’ช -You can: -Add new modules -Improve documentation -Optimize existing components -Fix bugs or issues +Contributions are welcome and encouraged! ๐Ÿ’ช
+You can:
+Add new modules
+Improve documentation
+Optimize existing components
+Fix bugs or issues
-To learn more about contributing, please read the Contributing Guide -For development standards, check the Development Guide +To learn more about contributing, please read the Contributing Guide
+For development standards, check the Development Guide
-๐Ÿ’ฌ **Community & Support** -If you have questions, ideas, or issues: -Check out the Issues section. -Start a discussion or suggest improvements. -Follow rtCamp on GitHub for updates. +๐Ÿ’ฌ **Community & Support**
+If you have questions, ideas, or issues:
+Check out the Issues section.
+Start a discussion or suggest improvements.
+Follow rtCamp on GitHub for updates.
-๐Ÿงพ **License** -This project is licensed under the AGPL-3.0 License โ€” see the LICENSE file for details. +๐Ÿงพ **License**
+This project is licensed under the AGPL-3.0 License โ€” see the LICENSE file for details.
-๐Ÿ’ผ BTW, We're Hiring! +๐Ÿ’ผ BTW, We're Hiring!
Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions From 6908deb0ba6eda142451cdd80b2d7b4284fdf1ea Mon Sep 17 00:00:00 2001 From: Sahil Davkhar <141304285+Sahildavkhar@users.noreply.github.com> Date: Mon, 6 Oct 2025 18:01:52 +0530 Subject: [PATCH 5/6] Update README.md --- README.md | 39 +++++++++++++++------------------------ 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 87b3a2b8..f65c082f 100644 --- a/README.md +++ b/README.md @@ -104,27 +104,18 @@ Package Description
@snapwp/blocks WordPress block rendering
@snapwp/query GraphQL query manager
-๐Ÿงฉ **Development & Contributing**
-SnapWP is under active development and maintained by rtCamp.
- -Contributions are welcome and encouraged! ๐Ÿ’ช
-You can:
-Add new modules
-Improve documentation
-Optimize existing components
-Fix bugs or issues
- -To learn more about contributing, please read the Contributing Guide
-For development standards, check the Development Guide
- -๐Ÿ’ฌ **Community & Support**
-If you have questions, ideas, or issues:
-Check out the Issues section.
-Start a discussion or suggest improvements.
-Follow rtCamp on GitHub for updates.
- -๐Ÿงพ **License**
-This project is licensed under the AGPL-3.0 License โ€” see the LICENSE file for details.
- -๐Ÿ’ผ BTW, We're Hiring!
- Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions +## Development & Contributing + +[SnapWP](https://github.com/rtCamp/snapwp) is under active development and maintained by [rtCamp](https://rtcamp.com/). + +Contributions are _welcome_ and **encouraged!** To learn more about contributing to SnapWP, please read the [Contributing Guide](/.github/CONTRIBUTING.md). + +For development guidelines, please refer to our [Development Guide](./DEVELOPMENT.md). + +## License + +This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details. + +## BTW, We're Hiring! + +Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions From 3989bcee62a9b75013b548e5041f8eccf5071225 Mon Sep 17 00:00:00 2001 From: Sahil Davkhar <141304285+Sahildavkhar@users.noreply.github.com> Date: Mon, 6 Oct 2025 18:02:23 +0530 Subject: [PATCH 6/6] Update README.md