Bootstrap your API Mesh development with ease.
Simply use the template to create a new repo and get started with Github Codespaces to write, test and deploy all from the browser.
This repo comes with all the files necessary to get started with API Mesh:
mesh.json- sample mesh config with a single source.env- environment file with variables for the config presented in mesh.jsonpackage.json- dependencies and scripts to test and deploy meshes.vscode/launch.json- VS Code configuration to setup debugging out of the box. This applies to VS Code on local machines or Codespaces on Github.com.devcontainer/devcontainer.json- Codespaces configuration to setup dev container out of the box. This config will help setup the packages and build the mesh config automatically. As a bonus it also sets up port-forwarding so you can use your favourite GraphQL interface to practice the mesh.github/workflows/deployMesh.yml- Github workflow to automatically publish mesh config when something is committed tomain
Clone the repo to your local machine and run yarn install to automatically setup required packages, aio and api-mesh plugins.
To run the mesh config presented in mesh.json, run yarn start to build and run the local mesh server.
Click on the Green Code button in the repo page and switch to Codespaces. Then click the Create codespaces on main button to automatically create a codepsace with default config from the template.
It is also possible to create a codespace with custom configuration, follow the Github Codepsaces guide for more information.
This repo comes with CICD out of the box but it will need Github Secrets to deploy meshes.
Please add the following secrets to the repo upon setup. Follow the CICD guide to learn more about acquiring the required secrets.
- API_KEY
- CLIENTID
- CLIENTSECRET
- IMSORGID
- ORGID
- PROJECTID
- TECHNICALACCEMAIL
- TECHNICALACCID
- WORKSPACEID