Sigmoid Generator

Sigmoid generator is a test project built with lerna and yarn workspaces. It is a simple tool that generates a sigmoid function with a given start, end, mean and deviation.

A live demo is available here
A live storybook is available here

Table of Contents

• Getting Started
• Main dependencies
• Project structure
• Being Pragmatic
• Running the project
• Running the tests
• Running Storybook

Main dependencies

• React
• Vite with SWC
• Typescript
• Lerna
• Yarn Workspaces
• TailwindCSS & DaisyUI
• Jest
• React Testing Library
• Storybook
• react-i18next
• recharts

---

Project structure

• packages: contains all the packages of the project
  • theme: contains the theme and UIKit of the project
  • app: contains the main app of the project

Being Pragmatic

This project is a test project. It is not meant to be used in production. That's why I chose to build it with Vite and SWC instead of CRA or NextJS (No SSR or SEO neededed).

Lerna and Yarn Workspaces are used to manage the project. It is a good way to manage a monorepo and to share dependencies between packages.

Everything is built with Typescript, tested with Jest and React Testing Library and documented with Storybook.

---

Running the project

A step by step series of examples that tell you how to get a development environment running:

1. Clone the repository:

git clone https://github.com/nolannbiron/SigmoidGenerator.git

2. Install dependencies:

yarn install

3. Build the project:

yarn build

4. Run the project:

yarn start

---

Running the tests

To run the tests, run the following command:

yarn test

---

Running Storybook

To run Storybook, run the following command:

yarn storybook