Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.45 KB

SETUP.md

File metadata and controls

33 lines (19 loc) · 1.45 KB
Raw

Setup

To get started, all you need to do is:

  1. Create a new project (see ReadMe Project Data Disclaimer below) on ReadMe and populate your ReadMe API Key in your .env with the following format:
API_KEY=<Your ReadMe API Key Here>
  • Note: make sure there are no spaces around the equal sign or after your API key!
  1. In your terminal, run the following command (and answer the subsequent prompts) to generate your OpenAPI definition and upload it to your ReadMe project:
npm run upload
  1. Feel free to poke around in the code — when you're ready, click the Show button to interact with your very own Hoot platform!

ReadMe Project Data Disclaimer

Be sure to create a new project on ReadMe — we do not recommend connecting Hoot to an exising ReadMe project that is already connected to a production API!

The Custom Login and API Metrics examples in this code are simplified and for demonstrative purposes.

FAQ

Where can I access my terminal if I'm using Glitch?

Click the Tools button in the lower-lefthand corner and select Terminal (see image below). If you can't see the Tools button, you'll need to remix the project first!

Glitch Terminal Screenshot