Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated init to support Quick Start setup #145

Merged
merged 6 commits into from
Jul 17, 2024
Merged

Conversation

revanth0212
Copy link
Contributor

@revanth0212 revanth0212 commented Jun 25, 2024

Description

In an effort to make it easy for mesh developers to get started we have embarked on a quick start template to setup and test meshes both on the local and on github codespaces.

This PR adds the same template files to the init command to make the output of init command to look similar to the output of the template.

Draft template: https://github.com/revanth0212/api-mesh-starter-kit

Related Issue

https://jira.corp.adobe.com/browse/CEXT-3347

Motivation and Context

Better DevEx

How Has This Been Tested?

This structure has already been validated on the quick start template.

Steps:

  1. Run init command
  2. Update mesh.json/.env with the necessary details
  3. Run start command yarn start mesh.json
  4. Alternatively run aio api-mesh run mesh.json
  5. Run debug command yarn debug mesh.json
  6. Alternatively run aio api-mesh run mesh.json --debug
  7. Upload the init folder to github and create a codespace
  8. Run start and debug command to verify the same behavior (aio api-mesh run does not work directly on codespaces)

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@revanth0212 revanth0212 marked this pull request as ready for review June 28, 2024 19:39
@@ -0,0 +1,42 @@
# API Mesh Starter Kit
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the sample readme from the quick start guide. We need to change this for the init command output. @jhadobe I could use your help to modify this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@revanth0212 please review this PR AdobeDocs/graphql-mesh-gateway#216. The readme in this repo should link to the documentation site after it is published.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have a potential link for the published doc page? Ill add it the readme and the link will be active once the docs are published. Anyways these 2 PRs will go live at the same time.

Also, what do you think the contexts of this readme should be? Just a heading and a link to the doc page or something else?

Copy link
Contributor

@jhadobe jhadobe Jul 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@revanth0212 it depends when you want to merge this to main. i'm waiting on some url forwarding. the destination will be: https://developer.adobe.com/graphql-mesh-gateway/mesh/template (after the merge), which should take place in the next day or so (just waiting on the release to be published).

I think it should contain a brief overview of the files and their purpose, but yes, mainly a link to the docs.

brasewel
brasewel previously approved these changes Jul 17, 2024
kmaschi
kmaschi previously approved these changes Jul 17, 2024
jward-magento
jward-magento previously approved these changes Jul 17, 2024
@revanth0212 revanth0212 dismissed stale reviews from jward-magento, kmaschi, and brasewel via b7657bc July 17, 2024 20:00
@revanth0212 revanth0212 merged commit b358ac5 into develop Jul 17, 2024
3 checks passed
@revanth0212 revanth0212 deleted the feature/quickSetup branch July 17, 2024 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants