diff --git a/README.md b/README.md index 1e9b3160..f65c082f 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,6 +73,37 @@ SnapWP provides several plugins, packages, and libraries that can be used indivi - [NextJS Middleware](docs/middleware.md) - [Static Exports](docs/static-exports.md) +--- + +## 🧑‍💻 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 +``` + +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
+ ## Development & Contributing [SnapWP](https://github.com/rtCamp/snapwp) is under active development and maintained by [rtCamp](https://rtcamp.com/).