https://github.com/stepzen-dev/template
template to start any sample off
https://github.com/stepzen-dev/template
Last synced: 3 months ago
JSON representation
template to start any sample off
- Host: GitHub
- URL: https://github.com/stepzen-dev/template
- Owner: stepzen-dev
- Created: 2021-07-07T21:39:40.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-21T16:37:51.000Z (over 4 years ago)
- Last Synced: 2025-04-25T11:50:41.789Z (about 1 year ago)
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# template
# Introduction
*Description of the project. Include what technologies it uses and why you picked them for the project. Include a screenshot of the homepage here and change the width=600*
## Getting Started
You'll need to create a [StepZen account](https://stepzen.com/request-invite) first. Once you've got that set up, [git clone](https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone) this repository onto your machine and open the working directory.
If there is another data source, discuss setting it up here.
*include where to get any api tokens or info here*
Make a file in it called `config.yaml`
*show the yaml file and explain what's in it-- auth for the API etc*
Open your terminal and [install the StepZen CLI](https://stepzen.com/docs/quick-start).
After you've followed the prompts (you can accept the suggested endpoint name-- in my case it was `api/happy-bunny`) and installed the CLI, run `stepzen start`.
A message similar to this will display:
```bash
Watching ~/gql-github for GraphQL changes
http://localhost:5000/api/happy-bunny
File changed: /Users/luciacerchie/gql-github/.git/config
Deploying to StepZen...... done
Successfully deployed api/happy-bunny at 9:00:07 AM
```
You'll see your StepZen Explorer pop up on your localhost:5000 address:
*include screenshot of your graphiql editor here with width set to 600*
In the left pane, copy and paste:
*include sample graphql query text here*
and you'll get the response:
*include sample json response here*
## Open up the UI in your browser
*Put steps to do this here. Will the user have to run npm or yarn? Is there anything they have to add to code to configure it, like a .env file?*
## Learn More
You can learn more in the [StepZen documentation](https://stepzen.com/docs).