Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 2.74 KB

README.md

File metadata and controls

59 lines (34 loc) · 2.74 KB
Raw

Lona Studio

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

Lona Studio is still fairly 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, Cocoapods, and Carthage 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.

If you have multiple versions of Xcode installed, you may need to select which one to use when building from the command line: https://stackoverflow.com/a/41536029

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, either use File > Open or click the "Open workspace..." button:

Open Workspace

Compiler

The Lona Studio mac app binary includes a build of the Lona compiler. However, if you're building Lona Studio from source, you'll need to build the compiler. To build the compiler, follow these instructions and then run yarn deploy to copy the built compiler into the appropriate Lona Studio directory.

Alternately, you may install lonac via npm (e.g. npm install --global lonac) and set the path in Lona Studio. You can set the path in LonaStudio -> Preferences -> Custom Compiler Path. You can find the lonac path using npm root -g (which is expected to be /usr/local/lib/node_modules/lonac).

Now you're ready to generate code from Lona components!