You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-1Lines changed: 38 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,39 @@ RingCentral integration widgets aim to provide reusable RingCentral service modu
12
12
13
13
This project includes [RingCentral Integration Common Library](packages/ringcentral-integration/README.md) and [RingCentral Widgets Library](packages/ringcentral-widgets/README.md). The basic idea is to connect modules in RingCentral Integration Common Library with React components to provide ready to use UI widgets.
14
14
15
-
## Setup with development environment
15
+
## Get Started
16
+
17
+
We use [RingCentral Widgets CLI](packages/ringcentral-widgets-cli/README.md) to startup a RingCentral Widgets based app.
18
+
19
+
```
20
+
$ npm install -g ringcentral-widgets-cli
21
+
$ rc-widgets -h
22
+
```
23
+
24
+
### Create a new project
25
+
26
+
```
27
+
rc-widgets new your_project_name
28
+
cd your_project_name
29
+
yarn install
30
+
```
31
+
32
+
[Update `.env` file in project root path](packages/ringcentral-widgets-cli/README.md#start-developement-server).
33
+
34
+
### Start development server
35
+
36
+
```
37
+
$ yarn start
38
+
```
39
+
Visit on [http://localhost:8080](http://localhost:8080) in browser.
40
+
41
+
For production build and deploy, please get more information in [here](packages/ringcentral-widgets-cli/README.md).
42
+
43
+
### Tutorials
44
+
45
+
This is a [demo](https://github.com/embbnux/ringcentral-widgets-demo) and [step-by-step tutorials](https://embbnux.github.io/ringcentral-widgets-demo/) show how to use this library.
46
+
47
+
## Contribution and Development
16
48
17
49
We use [Lerna.js](https://github.com/lerna/lerna) to manage packages source. And we require Node.js > 8.
18
50
@@ -56,3 +88,8 @@ Open up your browser and access http://localhost:8080 to see how it works.
56
88
57
89
Note that the development server is using OAuth for authorization process.
58
90
Please make sure the app you specified in configuration above is setup with Redirect Uri `http://localhost:8080/redirect.html`.
0 commit comments