THIS REPO IS DEPRECATED!

Use sui/packages/sui-studio instead.

Use sui-studio@4 as a local dependency in your projects. Follow migration guidelines to proceed.

suistudio

Sui Studio helps you to develop isolated UI components for your projects. See all your component library in a single repository, create demos for them and make them easy to be use on your organization. Develop, mantain and publish your components as packages and use them in your projects.

Getting Started

First install suistudio:

npm i -g @schibstedspain/sui-studio
suistudio init <project_name>
cd <project_name>

Once you're in the new project, you can execute suistudio start in order to start the development browser and start working on your components.

Workflows

Creating a new component

1) Create a component

$ suistudio generate house window

2) Install component dependencies

$ suistudio run-all npm install

3) Commit changes using the appropiate command

First of all, stage you changes for commit with git add or whatever you use.

DO NOT use git commit directly. Instead, use:

$ npm run co

It will prompt a question form. The way you answer to this question form affects the way the commit's comment is built. Comments will be used later, after merging to master in order to decide what kind of change (release) is going to be done (minor or major).

Then just push your changes using git push and merge them into master after review.

4) Release

Select master branch. First, check that the release will be properly built by executing:

$ suistudio check-release

If the output is the expected then run:

$ suistudio release

Conventions

Naming

lowerCamelCase is the choice for directories and files.

components/house/mainWindow/...