https://github.com/cloudstitch/framer.module.cloudstitch

https://github.com/cloudstitch/framer.module.cloudstitch

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cloudstitch/framer.module.cloudstitch
• Owner: cloudstitch
• License: mit
• Created: 2016-09-14T00:48:39.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-01T21:22:06.000Z (almost 8 years ago)
• Last Synced: 2024-08-04T00:10:24.880Z (5 months ago)
• Language: HTML
• Size: 1.2 MB
• Stars: 15
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-framer - Cloudstitch Framer Module - Module lets you load data from Google Spreadsheets and Microsoft Excel directly into your Framer projects. (Modules)

README

        


The **Cloudstitch Framer Module** lets you load data from Google Spreadsheets and Microsoft Excel directly into your Framer projects.

We think designers should work with _realistic_ data as often as possible. It informs your design decisions, lets you find edge cases that need to be accommodated, and makes for much better demos. 

But keeping your data in JSON files is no fun: they're a pain to edit and can't be easily shared. Cloudstitch lets you load the data from shared spreadsheets in the cloud instead.

## How to Install

Add the ```cloudstitch.coffee``` file to the `/modules` folder of your project. You can find it in the `/modules` folder of the example project included in this repository.

This git repository is also a working Framer project that serves as an example. Download it and double click `cloudstitch.framer` file to see.

## How to Use

### 1. Create a spreadsheet using Cloudstitch



Clone the [Framer Module Demo](https://www.cloudstitch.com/project-templates/framer-module-demo/clone) on Cloudstitch and then edit the spreadsheet created for your new project.

This spreadsheet acts as the datasource that you can load from Framer.

### 2. Sync your spreadsheet with Cloudstitch



When you're done editing the spreadsheet, press the green **Sync with your Template** button in Cloudstitch. This makes a fresh copy of your spreadsheet available over Cloudstitch's API.

### 3. Use the spreadsheet data in Framer

Include the Cloudstitch module within your project by adding the following:

``` coffeescript

cloudstitch = require "cloudstitch"

```

Then get data from your spreadsheet by providing the Cloudstitch username and appname of your project:

``` coffeescript

cloudstitch.get(username, appname, (data) -> callback(data))

```

In that code snippet, `callback` is a function that will get called and passed the variable `data`, which contains all the tables from your spreadsheet.  

You can find the username and appname for your Cloudstitch project by looking at its URL:



### 4. Examples and Code

Download the library, along with working demo code, at [github.com/cloudstitch/framer.module.cloudstitch](http://github.com/cloudstitch/framer.module.cloudstitch)