https://github.com/mikearnaldi/matechs-effect-doc

https://github.com/mikearnaldi/matechs-effect-doc

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mikearnaldi/matechs-effect-doc
• Owner: mikearnaldi
• Created: 2019-12-14T18:11:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-29T14:01:07.000Z (over 4 years ago)
• Last Synced: 2024-10-12T22:56:30.704Z (2 months ago)
• Size: 134 KB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
---

description: 'And write better end to end software, so you can sleep at night!'

---

# How to use Effect!

## Getting Super Powers

You will aquire knowledge on how to build software in a purely functional manner, you will leverage a particular kind of algebraic effects called environmental effects in order to structure your code in a better way enabling you to test each individual component in an isolated way and making your modules reusable and composable.

We are not cheating, neither using magic tricks! By leveraging functional programming principles we have developed a set of libraries that enrich the [fp-ts](https://github.com/gcanti/fp-ts) ecosystem with the functionalities that you may find in a library like [ZIO](https://github.com/zio/zio) in the Scala ecosystem.

The latest development in the core TypeScript language allow us to take environment usage even further compared to what ZIO can achieve, namely TypeScript has a very good support for intersection types and this makes environment usage wonderful.

## Installation

So let's get the superpowers, bootstrap a new `yarn` project and install basic dependencies:

```text

$ mkdir my-project

$ yarn init -y

$ yarn add @matechs/aio

$ yarn add -D typescript

```

Note that @matechs/aio \(all-in-one\) includes all the required dependencies plus a rich set of optional libraries like io-ts, morphic-ts, newtype-ts, monocle-ts that makes development in typescript extremely productive

## License

The library is released with under MIT license and the codebase is fully open-source at:  

[https://github.com/Matechs-Garage/matechs-effect](https://github.com/Matechs-Garage/matechs-effect)

As with any good library there is a commercial project that support the development and maintainance, if you want to know more find us at [https://www.matechs.com/](https://www.matechs.com/) we are a digital accelerator looking for smart founders & projects to build!

## Notes

Docs are meant to be only for introduction to the architecture but are still outdated, for proper usage refer to the test & demo packages in each package in the github repo.

## Project Config

You will need to bootstrap a classic `npm` package with TypeScript configured in "strict" mode.