initial (public) commit

Co-authored-by: Amaan Khan <[email protected]>
Co-authored-by: Ashutosh Gautam <[email protected]>
Co-authored-by: ayushnirwal <[email protected]>
Co-authored-by: Immanuel Raj <[email protected]>
Co-authored-by: Riddhesh Sanghvi <[email protected]>
Co-authored-by: Shah Shalin <[email protected]>
Co-authored-by: Swanand01 <[email protected]>
Co-authored-by: Ta5r <[email protected]>

Author: 9 people

.env.example

@@ -0,0 +1,20 @@
+# Enable if connecting to a self-signed cert
+# NODE_TLS_REJECT_UNAUTHORIZED=0
+
+# The headless frontend domain URL. Uncomment this line and ensure the value matches the URL used by your frontend app.
+# NEXT_PUBLIC_URL=http://localhost:3000
+
+# The WordPress "frontend" domain URL
+NEXT_PUBLIC_WORDPRESS_URL=https://headless-demo.local
+
+# The WordPress GraphQL endpoint
+NEXT_PUBLIC_GRAPHQL_ENDPOINT=graphql
+
+# The WordPress Uploads directory path
+# NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH=/wp-content/uploads
+
+# The WordPress REST URL Prefix
+# NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX=/wp-json
+
+# Token used for authenticating GraphQL introspection queries
+INTROSPECTION_TOKEN=

.eslintignore

@@ -0,0 +1 @@
+/examples/**/*

.eslintrc.json

@@ -0,0 +1,31 @@
+{
+	"root": true,
+	"env": {
+		"node": true
+	},
+	"extends": "@snapwp/eslint-config",
+	"ignorePatterns": [
+		"**/node_modules/**",
+		"**/dist/**",
+		"**/dist-types/**",
+		"out/**",
+		"data/**",
+		"assets/**/*.js",
+		"coverage/**",
+		"**/config/*.js",
+		"**/dist",
+		"**/__generated/"
+	],
+	"globals": {
+		"globalThis": "readonly"
+	},
+	"overrides": [
+		// Disable n/no-process-env for codegen.ts file
+		{
+			"files": [ "**/codegen.ts", "**/*.test.*", "**/jest.setup.js" ],
+			"rules": {
+				"n/no-process-env": "off"
+			}
+		}
+	]
+}

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the overall
+    community
+
+Examples of unacceptable behavior include:
+
+-   The use of sexualized language or imagery, and sexual attention or advances of
+    any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email address,
+    without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to SnapWP
+
+Thank you for considering contributing to SnapWP! We appreciate your help in improving this open-source project. By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md) and adhere to the guidelines outlined below.
+
+## Code of Conduct
+
+Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md) to ensure a welcoming environment for all contributors. If you encounter any issues or wish to report a concern, please email us at [[email protected]](mailto:[email protected]).
+
+## How to Contribute
+
+### Reporting Issues
+
+> [!IMPORTANT]
+>
+> **Do not report potential security vulnerabilities in the public GitHub repository.** Instead, please email us at [[email protected]](mailto:[email protected]).
+>
+> For more information, refer to our [Security Policy](./SECURITY.md).
+
+If you find a bug or have a feature request, please open an issue in the [GitHub Issues](https://github.com/rtCamp/snapwp/issues) section. Provide as much detail as possible, including:
+
+1. A clear description of the issue.
+2. Steps to reproduce the issue.
+3. Any relevant screenshots or logs.
+
+In general, we recommend you adhere to the GitHub issue templates included in this repository whenever possible.
+
+> [!TIP]
+>
+> **Note**: Before opening a new issue, please search the [GitHub Issues](https://github.com/rtCamp/snapwp/issues) to see if a similar issue has already been reported.
+>
+> If you find an existing issue that matches your concern, you can upvote the issue or add a comment to provide additional context, reproduction steps, or any other relevant information to help the ticket advance.
+
+### Submitting Code
+
+1. **Fork the repository**: Click the "`Fork`" button in the top right corner of the repository page to create your own copy of the project.
+
+2. **Make your changes**: Implement the changes you'd like to contribute. Ensure that your code adheres to the project's [coding standards and guidelines](../DEVELOPMENT.md#code-quality--code-standards).
+
+> [!TIP]
+> For detailed information on the project's directory structure, local development setup, and testing processes, refer to the [DEVELOPMENT.md](../DEVELOPMENT.md) document.
+
+3. **Write tests**: If possible, add/update the necessary Integration/Functional/etc. tests for your changes to ensure that everything works correctly.
+
+4. **Commit and push your changes**: Once you're satisfied with your changes, commit them to your forked repository and push them to your branch.
+
+5. **Create a pull request**: Submit a `Pull Request` to the `develop` branch of this repository. Select your branch and provide a detailed description of your changes.
+   Pull Request titles should be concise, descriptive, and follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. E.g., `feat: Add new feature`.
+
+#### Review Process
+
+1. Your pull request will be reviewed by a maintainer. We'll review all PRs, and make suggestions or changes as needed.
+2. Once approved, your PR will be squashed and merged into the `develop` branch.
+
+### Contributing Documentation
+
+We aim to maintain thorough documentation for all aspects of the project. Please contribute by documenting any new features, endpoints, or functionalities you implement.
+
+You can refer to existing documentation in the [`docs`](../docs) directory for examples of how to structure and format your documentation.
+
+## Thank You!
+
+We appreciate your time and contributions to the `SnapWP` project. Your efforts help make this project better for everyone!

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,72 @@
+name: Bug report
+description: Create a bug report for SnapWP
+body:
+    - type: markdown
+      attributes:
+          value: >-
+              Thank you for taking the time to report a possible bug!
+
+              Please remember, a bug report is not the place to ask questions. You can
+              use Discord for that, or start a topic in [GitHub
+              Discussions](https://github.com/rtCamp/snapwp/discussions).
+
+    - type: textarea
+      attributes:
+          label: Description
+          description: >-
+              Please write a brief description of the bug, including what you expected
+              and what actually happened.
+      validations:
+          required: true
+
+    - type: input
+      attributes:
+          label: Link to the code that reproduces this issue
+          description: |
+              A link to a **public**[GitHub repository or a CodeSandbox minimal reproduction. 
+
+              **Skipping this/providing an invalid link may result in the issue being closed.**
+          placeholder: 'https://github.com/user/my-minimal-snapwp-reproduction'
+      validations:
+          required: true
+
+    - type: textarea
+      attributes:
+          label: To Reproduce
+          description: A step-by-step description of how to reproduce the issue, based on the linked reproduction.
+          placeholder: |
+              1. Start the application in development (next dev)
+              2. Click X
+              3. Y will happen
+      validations:
+          required: true
+
+    - type: textarea
+      attributes:
+          label: Additional context
+          description: >-
+              Add any other context about the problem here that might help us investigate, such as screenshots, error
+              logs, etc.
+
+    - type: textarea
+      attributes:
+          label: Frontend Environment
+          description: Please provide details about your frontend environment. We recommend you run `next info` and share the output.
+          render: bash
+
+    - type: textarea
+      attributes:
+          label: Backend Environment
+          description: Please provide details about your backend environment. We recommend you go Admin > Site Health > Info and share the output.
+          render: bash
+
+    - type: checkboxes
+      attributes:
+          label: Please confirm that you have searched existing issues in the repo.
+          description: >-
+              You can do this by searching
+              https://github.com/rtCamp/snapwp/issues and making sure the
+              bug has not been reported before.
+          options:
+              - label: 'Yes'
+                required: true

.github/ISSUE_TEMPLATE/config,yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: General Support Request
+    url: https://github.com/rtCamp/snapwp/discussions
+    about: For general help requests, create a new topic in Github Discussions

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,39 @@
+name: Feature request
+description: Suggest a new feature or enhancement for SnapWP
+body:
+    - type: markdown
+      attributes:
+          value: >-
+              Thank you for taking the time to submit a feature request.
+
+
+              Please make sure to search the repo for [existing feature
+              requests](@todo) before creating a new one.
+    - type: textarea
+      attributes:
+          label: What problem does this address?
+          description: >-
+              Please describe the problem you are trying to solve, including why you
+              think this is a problem.
+          placeholder: I'm always frustrated when [...]
+      validations:
+          required: true
+    - type: textarea
+      attributes:
+          label: What is your proposed solution?
+          description: >-
+              Please provide a clear and concise description of your suggested
+              solution.
+          placeholder: What I'd like to see happen is [...]
+      validations:
+          required: true
+    - type: textarea
+      attributes:
+          label: What alternatives have you considered?
+          description: >-
+              Please list any alternatives you have considered, and why you think your
+              solution is better.
+    - type: textarea
+      attributes:
+          label: Additional Context
+          description: Add any other context or screenshots about the feature request here.