A boilerplate FramerJS project that uses Gulp for live reload and CoffeScript transpilation1 + Browserify to include modules
This project will help you if you:
modules
folderTo use this project, you will first need to install NodeJS. You can do it from the official website.
npm install
from the project folder. This will install all the required dependenciesgulp
. If you have not installed it: npm install -g gulp
http://localhost:3000
on Chromeapp/app.coffee
. Any changes on the Framer code will refresh the browserIf you want to create a Framer Studio project to be shared, you just need to:
gulp export
when you think your project is ready to be exportedframer-boilerplate.framer
in the exports
folder with Framer StudioThere are two known limitations for this export process:
You can add as many submodules as you want in the modules
folder. In the sample code included, you can see a module called myModule
. To include it:
MyModule = require("myModule")
(same as in Framer Studio)
You can create subfolders in the modules
folder and include it using:
MyModule = require("subfolder/myModule")
NOTE: At the moment, Framer Studio expects all submodules to be in a flat modules
folder. If you create complex folder hierarchies inside the modules
folder, you won't be able to open your project on Framer Studio.
To avoid compiling Framer on Windows machine, where the make
command is not available by default, this boilerplate includes a precompiled version of Framer that I keep updating on this repo. This process is done manually at the moment, so let me know if you run into problems with the current version of FramerJS included. If you have any idea to make this process cleaner or easier, please let me know.
1Does this word even exist??