Skip to content

This is an API that handles errors using the either pattern.

License

Notifications You must be signed in to change notification settings

lucfersan/errors-with-either

Repository files navigation

js-standard-style License: MIT Open Source

Errors With Either

This is an API that handles errors using the either pattern.
Explore the docs »

· Report Bug · Request Feature

🐾 About The Project

I've been studying other ways to handle errors without having to throw all the time and I found the Either pattern which is quite famous, so I've given it a try.

The Umbriel project helped me to study and made things clearer about where I should go, so I find it's good to mention it.

🚀 Installation

  1. Clone the repo
    git clone https://github.com/lucfersan/errors-with-either
  2. Install NPM packages
    yarn
  3. Create a database and a Postgres server using docker or your local machine.

🖥️ Running the app

# development
$ npm run dev

# production mode
$ npm start

🔺 Prisma Studio

$ npx prisma studio

🗞️ License

Distributed under the MIT License. See LICENSE for more information.

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📧 Contact

Lucas Fernandes - fernandes.lucas11@outlook.com