Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/PurpleKingdomGames/tyrian

Elm-inspired Scala UI library.
https://github.com/PurpleKingdomGames/tyrian

elm-architecture front-end-development scala scala-js scalajs tyrian ui

Last synced: 3 months ago
JSON representation

Elm-inspired Scala UI library.

Host: GitHub
URL: https://github.com/PurpleKingdomGames/tyrian
Owner: PurpleKingdomGames
License: mit
Created: 2021-06-04T19:39:08.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-04-14T10:56:35.000Z (10 months ago)
Last Synced: 2024-05-01T11:28:12.867Z (9 months ago)
Topics: elm-architecture, front-end-development, scala, scala-js, scalajs, tyrian, ui
Language: Scala
Homepage: https://tyrian.indigoengine.io/
Size: 17.8 MB
Stars: 315
Watchers: 9
Forks: 23
Open Issues: 18
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-ccamel - PurpleKingdomGames/tyrian - Elm-inspired Scala UI library. (Scala)

README

[![MIT License](https://img.shields.io/github/license/PurpleKingdomGames/tyrian?color=indigo)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)
[![Latest Tagged Release](https://img.shields.io/badge/dynamic/json?color=purple&label=latest%20release&query=%24%5B0%5D.name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FPurpleKingdomGames%2Ftyrian%2Ftags)](https://github.com/PurpleKingdomGames/tyrian/releases)
[![Discord Chat](https://img.shields.io/discord/716435281208672356?color=blue&label=discord)](https://discord.gg/b5CD47g)
[![CI](https://github.com/PurpleKingdomGames/tyrian/actions/workflows/ci.yml/badge.svg)](https://github.com/PurpleKingdomGames/tyrian/actions/workflows/ci.yml)

# Tyrian

An Elm-inspired Scala UI library for Scala 3.

The main documentation site, complete with installation instructions, is available here:
[tyrian.indigoengine.io/](https://tyrian.indigoengine.io/)

## Thank you, to our sponsors! 💜

Thank you to all our wonderful sponsors, and particularly to [dedipresta](https://www.dedipresta.com/) for their generous support.

![dedipresta](sponsors/dedipresta.png)

If you'd like to help advance our work, we are ever grateful for all forms of contribution, either by volunteering time or [financial backing](https://github.com/sponsors/PurpleKingdomGames?o=esb).

## Local build instructions

Tyrian is fairly straight forward to build locally, run the following commands from your terminal in the project root:

```sh
npm install
sbt clean update compile test +publishLocal
```

There is also a `build.sh` script in the root folder, but that also builds the docs and example projects (based on the currently released version).

### Nix dev-shell

If you would like to have the environment set up without installing any dependencies globally (think `node`, `yarn`, `java`, etc), you can give the [Nix](https://nixos.org/) development shells a try.

To use this functionality, you are required to enable [flakes](https://nixos.wiki/wiki/Flakes#Installing_flakes).

#### Usage

```console
$ nix develop
```

Locally you can run `nix develop`. However, if you would like to use the same shell in a different repository, you can run the following command instead.

```console
nix develop github:PurpleKingdomGames/tyrian
```

#### What do you get?

The default dev shell ships with jdk, mill, sbt and coursier, ensuring all dependencies use the same JDK. It also ships with essential JS tooling in the form of yarn, npm and node.

```console
$ java --version
The program 'java' is not in your PATH. It is provided by several packages.

$ sbt --version
The program 'sbt' is not in your PATH. It is provided by several packages.

$ yarn --version
The program 'yarn' is not in your PATH. It is provided by several packages.

$ npm --version
The program 'npm' is not in your PATH. It is provided by several packages.

$ nix develop

$ java --version
openjdk 17.0.1 2021-10-19
OpenJDK Runtime Environment (build 17.0.1+12-nixos)
OpenJDK 64-Bit Server VM (build 17.0.1+12-nixos, mixed mode, sharing)

$ mill --version
Mill Build Tool version 0.10.0
Java version: 17.0.1, vendor: N/A, runtime: /nix/store/drg31yiw0619r981n0yyv7lnziiyxwww-openjdk-headless-17.0.1+12/lib/openjdk
Default locale: en_US, platform encoding: UTF-8
OS name: "Linux", version: 5.16.10, arch: amd64

$ sbt --version
sbt version in this project: 1.6.2
sbt script version: 1.6.2

$ cs java-home
/nix/store/drg31yiw0619r981n0yyv7lnziiyxwww-openjdk-headless-17.0.1+12

$ node --version
v16.14.0

$ npm --version
8.3.1

$ yarn --version
1.22.17
```