Docs-Init

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -0,0 +1,80 @@
+name: "Bug Report"
+description: Create a new ticket for a bug.
+title: "[BUG] - <title>"
+labels: [
+  "bug"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Please enter an explicit description of your issue
+      placeholder: Short and explicit description of your incident...
+    validations:
+      required: true
+  - type: input
+    id: reprod-url
+    attributes:
+      label: "Reproduction URL"
+      description: Please enter your GitHub URL to provide a reproduction of the issue
+      placeholder: ex. https://github.com/USERNAME/REPO-NAME
+    validations:
+      required: true
+  - type: textarea
+    id: reprod
+    attributes:
+      label: "Reproduction steps"
+      description: Please enter an explicit description of your issue
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+      value: |
+        ![DESCRIPTION](LINK.png)
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Logs"
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: bash
+    validations:
+      required: false
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: "Browsers"
+      description: What browsers are you seeing the problem on ?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Opera
+    validations:
+      required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: What is the impacted environment ?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -0,0 +1,71 @@
+name: "Feature Request"
+description: Create a new ticket for a new feature request
+title: "[REQUEST] - <title>"
+labels: [
+  "question"
+]
+body:
+  - type: input
+    id: start_date
+    attributes:
+      label: "Start Date"
+      description: Start of development
+      placeholder: "month/day/year"
+    validations:
+      required: false
+  - type: textarea
+    id: implementation_pr
+    attributes:
+      label: "Implementation PR"
+      description: Pull request used
+      placeholder: "#Pull Request ID"
+    validations:
+      required: false
+  - type: textarea
+    id: reference_issues
+    attributes:
+      label: "Reference Issues"
+      description: Common issues
+      placeholder: "#Issues IDs"
+    validations:
+      required: false
+  - type: textarea
+    id: summary
+    attributes:
+      label: "Summary"
+      description: Provide a brief explanation of the feature
+      placeholder: Describe in a few lines your feature request
+    validations:
+      required: true
+  - type: textarea
+    id: basic_example
+    attributes:
+      label: "Basic Example"
+      description: Indicate here some basic examples of your feature.
+      placeholder: A few specific words about your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: drawbacks
+    attributes:
+      label: "Drawbacks"
+      description: What are the drawbacks/impacts of your feature request ?
+      placeholder: Identify the drawbacks and impacts while being neutral on your feature request
+    validations:
+      required: true
+  - type: textarea
+    id: unresolved_question
+    attributes:
+      label: "Unresolved questions"
+      description: What questions still remain unresolved ?
+      placeholder: Identify any unresolved issues.
+    validations:
+      required: false
+  - type: input
+    id: organization
+    attributes:
+      label: "Your Organization"
+      description: Organization making the request.
+      placeholder: "acme"
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

README.md

@@ -1,84 +1,36 @@
-# Custom Objects Editor
+<img align="right" alt="Aries MACH Booster" width="300" src="https://www.ariessolutions.io/wp-content/uploads/2024/01/aries-about-us-imagery.png">
 
-This a Aries Labs initiative to have services that help companies go composable.
 
-## Start the development server
+# Custom Object Editor
 
-Run the following command to start the development server and launch the
-application:
+## Overview
+This project is a commercetools custom application that allows the end user to create, view, and manage custom objects directly from the Merchant Center. Custom objects are an extremely powerful feature of the Composable Commerce offering and is useful for storing all sorts of diverse data. This application adds to that power by exposing this data to a business user without the need to go through APIs.
 
-```bash
-$ yarn start
-```
+### Key Features
+- **User Interface:** Professional user interface that seemlessly matches the Merchant Center design.
+- **Easy Deploy:** The application can easily be deployed into multiple projects or organizations directly through the Merchant Center.
 
-## Run tests
 
-Run the following command to run the tests:
+## Getting Started
 
-```bash
-$ yarn test
-$ yarn test:watch
-```
 
-## Build the production bundles
 
-Run the following command to build the production bundles with webpack:
+## Contributing
+Contributions are welcome! Please feel free to submit pull requests or open issues to discuss proposed changes or report bugs.
 
-```bash
-$ yarn build
-```
+For major changes, please open an issue first to discuss what you would like to change. Ensure to update tests as appropriate.
 
-## Deployment
+## License
 
-The custom application includes configuration for both AWS (S3 & CloudFront) and
-Firebase serverless deployments built with `mc-script compile-html`.
+This source code is provided under the [GNU AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.en.html).
 
-- [Firebase](https://appkit.commercetools.com/deployment/example-firebase)
-- [AWS - S3 & CloudFront](https://appkit.commercetools.com/deployment/example-aws-s3-cloudfront)
+All work product released in this repository is provided ​“AS IS”. We makes no other warranties, express or implied, and hereby disclaims all implied warranties, including any warranty of merchantability and warranty of fitness for a particular purpose. The demo provided is for testing purposes only, does not include any form of SLA, and should not be used in a production environment.
 
-## Linting, formatting, and so on
+If you would like to discuss alternative licensing or leveraging this application in your composable stack, please [reach out to Aries Solutions](https://www.ariessolutions.io/contact-aries/) to discuss options.
 
-### Formatting code
+----
 
-Run the following command to format JS, CSS, JSON and GraphQL files
 
-```bash
-$ yarn format
-```
+# [Aries Labs](https://www.ariessolutions.io/)
 
-### Git Hooks
-
-Git hooks are configured using
-[Husky](https://github.com/typicode/husky/blob/master/DOCS.md). The root
-workspace runs all workspace hooks using Lerna
-([example repository](https://github.com/sudo-suhas/lint-staged-multi-pkg)). The
-hooks are configured as follows:
-
-- **Pre-commit**: JS, CSS, and GraphQL files are linted (ESLint/Stylelint) and
-  formatted (Prettier). Fixes are automatically added to Git.
-- **Commit Message**: Commit messages are linted against the
-  [conventional commit format](https://www.conventionalcommits.org) using
-  commitlint
-
-### Linting GraphQL Queries
-
-A pre-requisite for linting GraphQL queries is generating a `schema.graphql`
-file, which contains the Types exposed by CTP API. Every time that the API
-introduces new Types, Queries or Mutations, the local `schema.graphql` must be
-updated.
-
-### Generating GraphQL schema
-
-1. If you haven't done so already, create an API client under
-   `Settings -> Developer Settings` in Merchant Center for your project
-2. Generate an access token using the
-   [Client Credentials flow](https://docs.commercetools.com/http-api-authorization#client-credentials-flow)
-3. Export both your Merchant Center project key and generated access token as
-   environment variables
-4. Retrieve schema with `graphql-cli`
-
-```bash
-$ export PROJECT_KEY={project_key}
-$ export AUTH_TOKEN={access_token}
-$ npx graphql-cli get-schema
-```
+This project is part of the Aries Labs initiative. To learn more about Aries Solutions and other projects including the MACH Booster please visit our website. [ariessolutions.io](https://www.ariessolutions.io)

docs/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 gem 'jekyll-remote-theme'
-gem 'github-pages'
+gem 'github-pages'
+gem 'jekyll-include-cache'
+gem 'rake'
+gem 'webrick'