Skip to content
On this page

Getting Started

This library is in active development! ⚠️

Feel free to reach out if something seems weird, confusing or unnecessary complex.
I'm willing to learn and welcome any kind of feedback with open arms. 🤗

GitHubTwitter

Install dependencies

Here are three commands for the most used package managers.
I'll be biased and promote my favorite one first.

pnpm add -D @exposition/core
yarn add -D @exposition/core
npm install -D @exposition/core

Define an exposition

Create an Exposition with all necessary data 🔮

import { Exposition } from '@exposition/core'

const exposition = new Exposition({
  auth: {
    options: ['valid ✅', 'deny ❌']
  }
} as const)

Add an integration

Install @exposition/integrations and add it to your Exposition.

Start with msw 💡

Mock Service Worker is the primary integration and even the reason for this library. Therefore I highly recommend to start with the msw setup guide first.

Future 💫

I'm cooking new guides for the following topics:

Other topics in my head:

  • How to send links your colleagues — 🌐 @exposition/web looking at you
  • SSR — 🚌 Sync between backend and frontend

Got feedback &&|| ideas?

Feel free to reach out if something seems weird, confusing or unnecessary complex.
I'm willing to learn and welcome any kind of feedback with open arms. 🤗

GitHubTwitter

Released under the MIT License