From 4539e6710a3ca0fb9626c0b9da177b02709cc475 Mon Sep 17 00:00:00 2001 From: mwleklinskiVL Date: Fri, 29 Sep 2023 12:52:36 +0200 Subject: [PATCH 1/8] chore: TET-142 create Readme, add hero and description --- README.md | 7 ++++ header.svg | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 101 insertions(+) create mode 100644 README.md create mode 100644 header.svg diff --git a/README.md b/README.md new file mode 100644 index 00000000..9e849bee --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +css-in-readme + +# Tetrisly React + +🧩 Simplify your React applications with Tetrisly! Designed for effortless integration, Tetrisly offers user-friendly components that will enhance your projects. Plus, it's fully compatible with Figma for a seamless design and development experience. + +If you want to know more about Tetrisly, check out our website: [tetrisly.com](https://tetrisly.com/) diff --git a/header.svg b/header.svg new file mode 100644 index 00000000..d25f37d9 --- /dev/null +++ b/header.svg @@ -0,0 +1,94 @@ + + +
+ + +
+ + + + + + + + + + + + + +

Hello there, great to see you
👋

+
+
+ + \ No newline at end of file From 8787babc775181c4bda426e1f032329b53193f44 Mon Sep 17 00:00:00 2001 From: mwleklinskiVL Date: Fri, 29 Sep 2023 14:09:10 +0200 Subject: [PATCH 2/8] chore: TET-142 add content and VL logo --- README.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++ public/VLLogo.png | Bin 0 -> 20309 bytes 2 files changed, 77 insertions(+) create mode 100644 public/VLLogo.png diff --git a/README.md b/README.md index 9e849bee..c7c7cb8c 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,80 @@ 🧩 Simplify your React applications with Tetrisly! Designed for effortless integration, Tetrisly offers user-friendly components that will enhance your projects. Plus, it's fully compatible with Figma for a seamless design and development experience. If you want to know more about Tetrisly, check out our website: [tetrisly.com](https://tetrisly.com/) + +## Tech Stack + +- [React 18](https://react.dev/) +- [xstyled](https://xstyled.dev/) + +## Installation + +Install my-project with npm (you can do the same with yarn, pnpm or any other package manager) + +```bash + npm install @virtuslab/tetrisly-react +``` + +## Run Locally + +Clone the project + +```bash + git clone https://github.com/VirtusLab/tetrisly-react +``` + +Go to the project directory + +```bash + cd tetrisly-react +``` + +Install dependencies + +```bash + yarn install +``` + +Start the storybook server + +```bash + yarn storybook +``` + +## Running Tests + +To run tests, run the following command + +```bash + yarn test +``` + +## Documentation + +[Documentation](https://linktodocumentation) + +## Usage/Examples + +```typescript +import { Button } from '@virtuslab/tetrisly-react'; + +function App() { + return