https://github.com/stepzen-dev/demo-stickers
https://github.com/stepzen-dev/demo-stickers
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/stepzen-dev/demo-stickers
- Owner: stepzen-dev
- Created: 2021-10-14T03:38:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-21T13:19:39.000Z (over 4 years ago)
- Last Synced: 2025-01-11T20:15:05.102Z (over 1 year ago)
- Language: CSS
- Size: 2.18 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Stickers Page
Here's some of the code behind our [StepZen stickers page](https://stepzen.com/stickers)!
You can watch our demo here: https://www.youtube.com/watch?v=2xTqzzb2iaA
## 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.
We used Airtable and Lob -- Airtable for storing the addresses, and Lob for verifying them. If you want to clone down this project and use it as a starting point for your own stickers page, you'll need to sign up for both services and use the keys to fill your `config.yaml`, which you'll make inside your working directory. It will look something like:
```yaml
configurationset:
- configuration:
name: airtable_config
Authorization: Bearer PUT_YOUR_KEY_HERE
baseid: PUT_YOUR_BASE_ID_HERE
- configuration:
name: lob_test_config
Authorization: Basic PUT_YOUR_KEY_HERE
- configuration:
name: lob_live_config
Authorization: Basic PUT_YOUR_KEY_HERE
- configuration:
name: lob_dummy_live_config
Authorization: Basic PUT_YOUR_KEY_HERE
```
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 ~/demo-sticker for GraphQL changes
http://localhost:5000/api/happy-bunny
File changed: /Users/luciacerchie/demo-stickers/.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:
Click the 'Explorer' tab to begin adding queries.
## Open up the UI in your browser
To run the development version:
- `npm install`
- `cp .env.sample .env.local`
- `npm run dev`
The stickers url:
To build and run the production version:
- `npm install`
- `npm run build`
- `npm start -p 3000`
Both will run at
## Learn More
You can learn more in the [StepZen documentation](https://stepzen.com/docs). Reach out to us in [Discord](https://discord.com/invite/9k2VdPn2FR ) if you need any help!