gracjankn / Tapestry

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Tapestry

Introduction

This public repository contains information about the Project Tapestry prototype. It does not contain the source code for the app.

Note also that this is a work-in-progress and details are certain to change.

Documentation

A JavaScript-based API is used by Tapestry to gather information from the public Internet.

This document explains the variables, objects, actions, and functions that are available for JavaScript development. A section at the end explains how plug-ins are configured.

There is also a PDF with the prototype architecture. Everything in dark blue is covered in the document above.

Plugins

The Plugins folder shows examples of plugins that were created for the prototype. Each plugin is listed using a reverse domain name identifier.

Each plug-in has a configuration file that provides metadata to the prototype. For example, if OAuth is needed to make requests.

There is also a user interface configuration that specifies inputs for settings and variables for JavaScript code.

Finally, there is the JavaScript that implements the plug-in. The most complex example is the one used for Mastodon (138 lines). A simpler example checks the USGS Earthquake Summary (41 lines).

We feel confident that this simple API can be used to handle any information on the public Internet. (Even XML!)

Ideally, these plug-ins should be user installable. For example, if you have custom built Raspberry Pi monitoring your garden's water tank, it could be added to Tapestry to give periodic updates in a timeline. The challenge to accomplish that goal is building a secure distribution system for plug-ins.

Tapestry Loom

You can use the plug-ins above with our developer tool: Tapestry Loom. Download the macOS app and copy the plug-ins above to the plugins folder (click the "Open Plugins…" button to get there quickly). You can also add your own plug-ins to that folder and restart the app to test them out.

For more help, we suggest watching the screencast below then reviewing the Tapestry Loom - User Guide.

Screencast

For an in-depth look at what you can do with these files, take a moment to watch Project Tapestry - Weaving An API on YouTube. This 30 minute video will help you get set up, show some tip and tricks, and give you a demo of how they're used in an iOS app.

Kickstarter

We are running a Kickstarter to fund a native iOS app based on this prototype. If the idea of a configurable and customizable Internet excites you, please check it out!

About

License:MIT License


Languages

Language:JavaScript 100.0%