G-yhlee/tyrianApp

to start

1. sbt

- ~fastOptJS

2. yarn install

- yarn start

3. add .gitignore

tyrianApp

Setup instructions

To run the program in a browser you will need to have yarn (or npm) installed.

Before your first run and for your tests to work, you must install the node dependencies with:

yarn install

This example uses Parcel.js as our bundler and dev server, there are lots of other options you might prefer like Webpack, scalajs-bunder, or even just vanilla JavaScript.

We recommend you have two terminal tabs open in the directory containing this README file.

In the first, we'll run sbt.

sbt

From now on, we can recompile the app with fastOptJS or fullOptJS but please note that the tyrianapp.js file in the root is expecting the output from fastOptJS.

Run fastOptJS now to get an initial build in place.

Then start your dev server, with:

yarn start

Now navigate to http://localhost:1234/ to see your site running.

If you leave parcel's dev server running, all you have to do is another fastOptJS or fullOptJS and your app running in the browser should hot-reload the new code.

Supported Effect Types

From version 0.6.0, Tyrian supports both Cats Effect 3 and ZIO 2.0. This template defaults to CE3 and IO (as this is the author's habit), but there is an example of a ZIO tyrian project available, and conversion is fairly straightforward.

The build for the ZIO example has libraries that you need to add/replace. You need to set up the right imports and replace IO with Task.

Otherwise, it's identical.