@bigbinary/neeto-integrations-frontend 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,46 @@
1
+ @bigbinary/neeto-integrations-frontend
2
+
3
+ UI for integrations for all neeto products.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ yarn add @bigbinary/neeto-integrations-frontend
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ Available components:
14
+
15
+ View the [example app](./example/src/App.jsx) to see usage.
16
+
17
+ ## Development
18
+
19
+ Install all the dependencies by executing the following command
20
+
21
+ ```bash
22
+ yarn install
23
+ ```
24
+
25
+ ### Using example app
26
+
27
+ Start the development server using the `yarn start` command. Development server
28
+ will run the example app using webpack.
29
+
30
+ ### Using host application
31
+
32
+ 1. Clone this repository.
33
+ 2. Run `yarn install` to download the dependencies and setup the development
34
+ environment.
35
+ 3. Have a host application ready.
36
+ 4. Run `yarn build --watch` to automatically transpile code as you save the
37
+ file. You can omit the `--watch` flag if you want to run the build only once.
38
+ 5. In a different terminal, run `yalc publish` to publish the
39
+ neeto-integrations-frontend to the local yalc store.
40
+ 6. Run `yalc add @bigbinary/neeto-integrations-frontend` to install the
41
+ neeto-integrations-frontend to the host application.
42
+ 7. After making necessary changes to `neeto-integrations-frontend`, run
43
+ `yalc push` to push the changes to the host application (assuming that you
44
+ are in watch mode and the changes are bundled automatically). Restart
45
+ webpack-dev-server in host if changes are not applied.
46
+ 8. Video explanation on how to use yalc: https://vimeo.com/722958162/9e931b640c