Skip to content

Latest commit

 

History

History
73 lines (43 loc) · 2.45 KB

README.md

File metadata and controls

73 lines (43 loc) · 2.45 KB

Lona Studio

Lona Studio provides a graphical interface for working with .component files.

Lona Studio is still very unstable, so save frequently and make sure your workspace is backed up via git!

Installation

The easiest way to use Lona Studio is by downloading the prebuilt Mac App binary... but we're not distributing this until Lona Studio becomes more stable. For now, you'll have to build from source!

Building from Source

First, make sure you have bundler and Cocoapods installed. Then checkout the repo and run:

cd studio
bundle && bundle exec pod install
carthage bootstrap --new-resolver --platform macOS

Open LonaStudio.xcworkspace and build in Xcode 10+ on High Sierra+. If there are warnings (e.g. about project settings) you can ignore them.

Sketch export (optional)

To enable Sketch export (beta), you'll also need to install nvm, and run the following (assuming you're in the studio directory):

cd LonaStudio/Scripting/Modules/component-to-sketch
nvm install 8.4
npm install

Workspace

To work in Lona Studio, you'll need a properly configured workspace. A workspace is a directory containing, optionally, the following files:

  • colors.json
  • textStyles.json
  • gradients.json
  • shadows.json
  • types.json

Opening the material design directory in the examples directory of the repo is a good place to start.

You can read more about these in the file formats docs. Without these, Lona Studio will not display any colors or text styles in the pickers.

Creating a Workspace

You can create a new workspace from the launch screen:

Create Workspace

After clicking this button, type the name of a new directory. This will create a directory containing several of the JSON files described above.

Opening a Workspace

To open an existing workspace:

Open Workspace

Changing Workspaces

To change your workspace directory, first open Lona Studio preferences:

Open Preferences

Then choose a directory path:

Set Workspace Path

Don't modify the colors or text styles paths unless you really know what you're doing. They're kind of buggy.

If something doesn't work... try quitting and launching Lona Studio again 😢