@screencloud/alfie-alpha

App UI component library

Published to npm

Tools we use

• We use styled-components to style our components.
• We use styled-system to create components with constraint-based style props based on scales defined in our theme.

Building new components

All components and variables that should be made available to users of our package should be exported in index.ts.

If you create a new component or update an existing component please ensure to update our documentation site to reflect these changes.

How to develop a component locally

We usually use our documentation site as our workspace to develop new components or make changes to existing components however feel free to use your own app.

You can use yalc to work in your local environment to test your changes without publishing those changes to npm.

Create yalc package by running commands in alfie package -

yarn run build
yalc publish

In your dependent project run

yalc add @screencloud/alfie
yarn install

After the yalc package has been added to your dependent project you can just do an update after each publish.

yalc update

Using yalc edits your package.json and node modules to point at the yalc package. Please ensure to never commit this change.

To remove the yalc package in your dependent project run

yalc remove --all
yarn install

This removes all yalc package info from yalc.lock and updates your node modules to point to the published version.

Publishing

We use changesets to handle our versioned release to NPM.

Run yarn changeset in the top level apps folder. Select @screencloud/alfie in the changed packages using space to select.

Choose if your change was a major, minor or patch bump and add a useful summary of your change for the change logs. Changesets will generate a .changeset/ file which you should commit. Once your PR has been successfully merged a new PR will be generated in the apps repo by GitHub actions for you named Version Packages.

When you're ready to do a release, you can merge this PR and a GitHub action will run to publish your change automatically to npm. If you're not ready to do a release yet, that's fine, whenever you add more changesets to develop, this PR will be updated.