@orderingstack/front-components-product-configurator 0.0.0 → 0.0.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022
+Copyright (c) 2022 João Paulo Moraes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,25 +1,66 @@
-# @orderingstack/front-components-product-configurator
+# React Tailwindcss Boilerplate build with Vite
 
-This package contain ProductConfigurator component.
+This is a [ReactJS](https://reactjs.org) + [Vite](https://vitejs.dev) boilerplate to be used with [Tailwindcss](https://tailwindcss.com).
 
-## Usage
+## What is inside?
 
-`npm i @orderingstack/front-components-product-configurator`
+This project uses many tools like:
 
-```ts
-import { ProductConfigurator } from '@orderingstack/front-components-product-configurator/';
-import '@orderingstack/front-components-product-configurator/dist/style.css';
+- [ReactJS](https://reactjs.org)
+- [Vite](https://vitejs.dev)
+- [TypeScript](https://www.typescriptlang.org)
+- [Jest](https://jestjs.io)
+- [Testing Library](https://testing-library.com)
+- [Tailwindcss](https://tailwindcss.com)
+- [Eslint](https://eslint.org)
+- [Prettier](https://prettier.io)
 
-export const ProductConfiguratorWrapper = props => {
-  const { product } = props;
+## Getting Started
 
-  return (
-    <ProductConfigurator
-      product={product}
-      primaryColor="blue"
-      handleGoBack={() => console.log("handleGoBack)}
-      handleAddToBasket={ value => console.log(value)}
-    />
-  );
-};
+### Install
+
+Create the project.
+
+```bash
+npx degit joaopaulomoraes/reactjs-vite-tailwindcss-boilerplate my-app
+```
+
+Access the project directory.
+
+```bash
+cd my-app
+```
+
+Install dependencies.
+
+```bash
+npm install
+```
+
+Serve with hot reload at http://localhost:3000.
+
+```bash
+npm run dev
 ```
+
+### Lint
+
+```bash
+npm run lint
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Test
+
+```bash
+npm run test
+```
+
+## License
+
+This project is licensed under the MIT License.