An open API service indexing awesome lists of open source software.

https://github.com/rangle/radius-token-tango

Suite of tools to connect Design Tokens to Repositories, facilitating Figma workflows
https://github.com/rangle/radius-token-tango

Last synced: 9 months ago
JSON representation

Suite of tools to connect Design Tokens to Repositories, facilitating Figma workflows

Awesome Lists containing this project

README

          

# Radius Token Tango

![Banner](docs/tango-banner.png)

This repository contains the codebase for the Radius Token Tango project, which includes a Figma Widget and a web UI. The project is structured as a monorepo, containing multiple applications and packages.

## Table of Contents

- [Project Structure](#project-structure)
- [Installation](#installation)
- [Development](#development)
- [Build](#build)
- [Linting and Formatting](#linting-and-formatting)
- [Publishing the Widget](#publishing-the-widget)
- [Future Plans](#future-plans)

## Project Structure

The repository is organized as follows:

- **apps/token-tango-web-ui**: The web UI application for the Token Tango project.
- **apps/token-tango-widget**: The Figma Widget application for the Token Tango project.
- **packages/eslint-config**: Internal ESLint configuration package.
- **packages/typescript-config**: Internal TypeScript configuration package.
- **packages/bandoneon**: Small UI library for the web part of the app.

## Installation

To set up the project, you'll need to have [pnpm](https://pnpm.io/) installed. Once you have `pnpm`, run the following command to install all dependencies:

```sh
pnpm install
```

## Development

To start the development server for all apps, use the following command:

```sh
pnpm dev
```

This will run `turbo dev`, which starts the development server for all applications and packages.

## Build

To build all applications and packages, run:

```sh
pnpm build
```

This will run `turbo build`, which builds all the projects in the monorepo.

## Linting and Formatting

To lint the codebase, run:

```sh
pnpm lint
```

To format the codebase using Prettier, run:

```sh
pnpm format
```

## Publishing the Widget

To publish the Figma Widget, follow these steps:

1. Navigate to the `apps/token-tango-widget` directory.
2. Ensure you have the correct Figma manifest file located at `apps/manifest.json`.
3. Download and install the Desktop version of Figma: https://www.figma.com/downloads/
4. If you already have Figma, ensure your using the latest version.
5. Log in to your account and open the Figma desktop app
6. I suggest opening a file with Figma Variables
6. From the menu, select "Widgets" -> "Development" -> "Import widget from manifest..." ->
7. This opens the File Explorer, find and select: `apps/manifest.json`
8. The widget will load into the currently open Figma file.
9. It will position the Widget into a Frame which can affect your layout, be careful when inserting.
10. it's trivial to delete the widget and restore it from the right click menu.

## Future Plans

We plan to add more packages in the future, including:

- **Common Logic Library**: A library containing common logic used across the applications.
- **Command-Line Tool**: A tool for converting layer files to other formats.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.