From dc0c37b5c548122cc6290ec9ef7cbfa2a4a2ec96 Mon Sep 17 00:00:00 2001 From: Akalanka Perera Date: Sat, 24 Feb 2024 12:15:09 +0530 Subject: [PATCH] Docs: added feature list --- CONTRIBUTING.md | 29 +++++++++++++++++++ README.md | 61 ++++++++++++++++++++++++++++++--------- src/stories/configure.mdx | 8 ++--- 3 files changed, 80 insertions(+), 18 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a4f4357 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +## Installation + +Run `bun i @mezh-hq/react-seat-toolkit` to incorporate into your project
+ +## Getting started + +- Run `bun install` to install all dependencies +- Run `bun storybook` to start the storybooks dev server +- Run `bun build-storybook` to build the project for a web release +- Run `bun build` to build the project for a package release + +## Commit messages + +- We follow conventional commits during our development workflow as a good practice. More information can be found at their official [documentation](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples) +- Refer the [commitlint.config.js](https://github.com/akalanka47000/react-seat-toolkit/blob/main/commitlint.config.cjs) file for a full list of supported commit message prefixes + +## Additional tools + +- This project is bootstrapped with [Lefthook](https://evilmartians.com/opensource/lefthook), [Eslint](https://eslint.org/) and [Prettier](https://prettier.io/). Please make good use of them. + +
+ +## Pull request guidelines + +- Please label your PRs with the appropriate labels +- Please add a description to your PRs +- Please add a screenshot or a gif to your PRs if it's a UI change +- Please add a documentation update if it's a feature or a bug fix + diff --git a/README.md b/README.md index d2a62c5..b8215b9 100644 --- a/README.md +++ b/README.md @@ -12,26 +12,59 @@

-React UI library to design and render seat layouts +React UI library to design and render seat layouts. The library is still under active development and not yet ready for production use until the next major release (v1.0.0). -## Installation +## Features -Run `bun i react-seat-toolkit` to incorporate into your project
+- **JSON based**: Define your seat layout using JSON data and retrieve it back as JSON after customization ✓ -## Getting started +- **Customizable**: Customize the layout as per your requirements -- Run `bun install` to install all dependencies -- Run `bun storybook` to start the storybooks dev server -- Run `bun build-storybook` to build the project for a web release -- Run `bun build` to build the project for a package release + - **Seats** + - Add new seats ✓ + - Remove existing seats ✓ + - Change seat colors ✓ + - Change seat labels ✓ + - Change seat status ✓ + - Group seats together into categories ✓ + - Categorier (Manage seat categories) ✓ -## Commit messages + - **Pen** + - Draw on the layout using a pen tool to create custom shapes ✓ -- We follow conventional commits during our development workflow as a good practice. More information can be found at their official [documentation](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples) -- Refer the [commitlint.config.js](https://github.com/akalanka47000/react-seat-toolkit/blob/main/commitlint.config.cjs) file for a full list of supported commit message prefixes + - **Text** + - Add text to the layout ✓ + - Change text color ✓ + - Change text size ✓ + - Change text font weight ✓ -## Additional tools + - **Shapes** + - Add shapes to the layout ✓ + - Change shape color ✓ + - Change shape size ✓ + - Change shape border color ✓ -- This project is bootstrapped with [Lefthook](https://evilmartians.com/opensource/lefthook), [Eslint](https://eslint.org/) and [Prettier](https://prettier.io/). Please make good use of them. + - **Sections** + - Section manager ✗ + - Free seating sections ✗ -
+ - **Miscallaneous** + - Add, move around and scale background images ✓ + - Add and move around booths ✓ + - Multiple element selection and deselection ✓ + - Bring elements to front or back ✓ + +- **Responsive**: The layout is responsive and can be viewed on any device 🛠️ + +- **Preview**: Preview the layout in a separate window 🛠️ + +- **Designer mode and User mode**: Switch between designer and user mode to enable or disable customization 🛠️ + - Designer mode: Enable customization + - User mode: Disable customization + - Add callback functions to handle seat selection + +- **Override styles**: Override the default styles to match your application's theme 🛠️ + +## Contributing + +Please read [CONTRIBUTING.md](https://github.com/mezh-hq/react-seat-toolkit/blob/main/CONTRIBUTING.md) for details on setting up your development environment and the process for submitting pull requests to us. \ No newline at end of file diff --git a/src/stories/configure.mdx b/src/stories/configure.mdx index f48516b..4961db7 100644 --- a/src/stories/configure.mdx +++ b/src/stories/configure.mdx @@ -1,7 +1,7 @@ import { Meta } from "@storybook/blocks"; import { Button, Toaster, toast } from "../components"; -export const command = "bun install react-seat-toolkit" +export const command = "bun install @mezh-hq/react-seat-toolkit" export const copy = () => { navigator.clipboard.writeText(command); @@ -14,8 +14,8 @@ export const copy = () => {
- Complete toolkit for seat design - Just one command away... - + Complete toolkit for seat design + Just one command away... +