Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 3.07 KB

EXAMPLES.md

File metadata and controls

61 lines (43 loc) · 3.07 KB
Raw

Examples

Because Forthic apps often pull data from 3rd party sources like gsheets and Jira, it's natural for them to run as web apps -- this makes it possible to implement the OAuth flows.

These examples show how to incorporate a Forthic interpreter inside of a web app, but this is only for illustration >and not meant for production environments.

Example: Using the Cache

The coding-forthic/cache-example stores an array of strings in the cache and then reads them out again.

Example: Read Google Sheets

This example pulls live gsheet data, so it requires a bit of setup to authorize the API calls to Google.

Setup

If you already have a Google OAuth client, all you'll need is your client ID and secret. Otherwise, you'll need to generate new ones by registering an OAuth client with Google:

  1. Create a new Project at the Google Developer's Console
  2. In the sidebar, click on "OAuth consent screen" and select "Internal" as the user type
  3. In the sidebar, click on "Enabled APIs & services" and enable the Gsheets API
  4. In the sidebar, click on "Credentials" and create a new "OAuth 2.0 Client ID" noting the client ID and secret
    • Choose "Web application" from Application Type
    • Under Authorized redirect URIs add http://localhost:8000/update_google_oauth_token

Configuration

  1. Open the main.forthic file in server/apps/coding-forthic/gsheet-example
  2. Change the GSHEET-URL to be the URL of a gsheet you can read
  3. Save the file

Run the example

If you haven't specified your client ID and secret, you will be redirected to a form where you can enter these. The values are stored encrypted in a server/.secrets file on your computer.

If you haven't authorized your Google OAuth client to make calls on your behalf, you will be redirected to an OAuth Consent form where you can grant permission.

If everything works, you'll see the rows of your gsheet rendered into a webpage

Example: Read Jira Data

In order to run this example, you'll need to get an apitoken from your Jira instance. Here are the steps:

  1. From your Jira instance, click on your account icon in the right side of the menubar
  2. Select "Manage account"
  3. Click on the "Security" tab
  4. Under "API Token", click on "Create and manage API tokens"
  5. Click "Create API token" and make a note of it (you'll need it when you run the example for the first time)

Run the example

The first time you run this example, you'll be asked to fill out a Jira host, username and API token. After you submit the form, these will be encrypted and stored in ./app/examples/.secrets.

The example will render a list of incomplete Jira tickets updated over the past 3 days.