generator-ringcentral-widgets v0.0.6
generator-ringcentral-widgets
A generator tool to help initialize a RingCentral Widgets based app with one command.
Dependences
- Node.js >= 8
- yarn or NPM
Installation
First, install Yeoman and generator-ringcentral-widgets using npm (we assume you have pre-installed node.js > 8) or yarn.
npm install -g yo
npm install -g generator-ringcentral-widgets
Then generate your new project:
yo ringcentral-widgets
Start
Before you start, you need to create a RingCentral developer free account and create a new RingCentral app with platform type - "Browser Based" with permissions that you need. For base app, it requires Read Accounts
and Subscription Webhook
permissions.
Update .env
file in project root path
$ vim .env
API_CLIENT_ID=your ringcentral app client id
API_CLIENT_SECRET=your ringcentral app client secret
API_SERVER=ringcentral api server, eg: https://platform.devtest.ringcentral.com
REDIRECT_URI=your redirect uri, eg: http://localhost:8080/redirect.html
API_CLIENT_ID
is your ringcentral app client id.
API_CLIENT_SECRET
is your ringcentral app client secret.
API_SERVER
is ringcentral api server, https://platform.devtest.ringcentral.com
for sandbox environment and https://platform.ringcentral.com
for production.
REDIRECT_URI
is redirect uri that needs to add in your app settings in RingCentral Developer Website. For development in local, it should be http://localhost:8080/redirect.html
. After your deploy this app to network space, it should be your_host_address/redirect.html
.
Start development server
yarn start
Visit on http://localhost:8080 in browser
Build for production
- Update
.env
file with production config, such asAPI_SERVER
andREDIRECT_URI
. - Build project
$ yarn build
- Upload files in release folder to your network space and visit it in browser.
Tutotial
Read more
The genarated app project is based on RingCentral Commons and RingCentral Widgets.
Commons modules are built with RcModule and Dependency Injection.
RingCentral Commons depend on Redux.
RingCentral Widgets depend on React and RingCentral Commons.
The genarated app project is built with Webpack.