@socotra/ec-react-components 0.0.0-alpha.4 → 2.0.0

package/README.md

@@ -1,30 +1,59 @@
-# React + TypeScript + Vite
+# @socotra/ec-react-components
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A React component library for generating forms and other components for EC.
 
-Currently, two official plugins are available:
+This library is styled via [tailwindcss](https://tailwindcss.com/) and [shadcn/ui](https://ui.shadcn.com/).
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+- **Package name**: `@socotra/ec-react-components`
+- **Repo Path**: `packages/components`
+- **Install**:
+  ```sh
+  npm i @socotra/ec-react-components
+  ```
+- **Usage**:
 
-## Expanding the ESLint configuration
+  ```js
+  // Import style.css anywhere in your application, preferably at the root
+  import '@socotra/ec-react-components/dist/style.css';
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+  import { MyComponent } from '@socotra/ec-react-components';
+  ```
 
-- Configure the top-level `parserOptions` property like this:
+### Customization
 
-```js
-export default {
-	// other rules...
-	parserOptions: {
-		ecmaVersion: 'latest',
-		sourceType: 'module',
-		project: ['./tsconfig.json', './tsconfig.node.json'],
-		tsconfigRootDir: __dirname,
-	},
-};
+As this library is styled via shadcn components and tailwind, customization can be achieved by installing shadcn in your project. Follow the installation guide from [shadcn](https://ui.shadcn.com/docs/installation) and adjust your theme using the [theme creator](https://ui.shadcn.com/themes).
+
+Once you install shadcn, or if you are using it already, **delete the style.css import** to avoid style collisions
+
+### Running the Project
+
+To build the package:
+
+```sh
+pnpm run build
 ```
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+To run tests:
+
+```sh
+pnpm run test
+```
+
+To run the linter:
+
+```sh
+pnpm run lint
+```
+
+To run the sandbox
+
+```sh
+cd ../sandbox
+pnpm run dev
+```
+
+Installing directly for local development
+
+```sh
+pnpm i ../path/to/this/packages/components
+```