|
| 1 | +## Overview |
| 2 | +This is the "Quickstart React" example Monday app. |
| 3 | +<br>It can be used as a board view or dashboard widget, connected to a board and render data from the board using settings. |
| 4 | + |
| 5 | +<br>This app demonstrates how to use: |
| 6 | +- [settings](https://github.com/mondaycom/monday-sdk-js#mondaygettype-params--) |
| 7 | +- [context](https://github.com/mondaycom/monday-sdk-js#mondaygettype-params--) |
| 8 | +- [API](https://github.com/mondaycom/monday-sdk-js#mondayapiquery-options--) |
| 9 | + |
| 10 | +<br>You can find more info in our QuickStart guide [here](https://monday.com/developers/apps/quickstart-view/) |
| 11 | +<br />  |
| 12 | + |
| 13 | +## Run the project |
| 14 | + |
| 15 | +In the project directory, you should run: |
| 16 | + |
| 17 | +### `npm install` |
| 18 | + |
| 19 | +And then to run an application with automatic virtual ngrok tunnel, run: |
| 20 | + |
| 21 | +### `npm start` |
| 22 | + |
| 23 | +Visit http://localhost:4040/status and under "command_line section" find the URL. This is the public URL of your app, so you can use it to test it. |
| 24 | +F.e.: https://021eb6330099.ngrok.io |
| 25 | + |
| 26 | +## Configure Monday App |
| 27 | + |
| 28 | +1. Open monday.com, login to your account and go to a "Developers" section. |
| 29 | +2. Create a new "QuickStart View Example App" |
| 30 | +3. Open "OAuth & Permissions" section and add "boards:read" scope |
| 31 | +4. Open "Features" section and create a new "Boards View" feature |
| 32 | +5. Open "View setup" tab and fulfill in "Custom URL" field your ngrok public URL, which you got previously (f.e. https://021eb6330099.ngrok.io) |
| 33 | +6. Click "Boards" button and choose one of the boards with some data in it. |
| 34 | +7. Click "Preview button" |
| 35 | +8. Enjoy the Quickstart View Example app! |
| 36 | + |
| 37 | +## Release your app |
| 38 | +1. Run script |
| 39 | +### `npm run build` |
| 40 | +2. Zip your "./build" folder |
| 41 | +3. Open "Build" tab in your Feature |
| 42 | +4. Click "New Build" button |
| 43 | +5. Click "Upload" radio button and upload zip file with your build |
| 44 | +6. Go to any board and add your just released view |
| 45 | +7. Enjoy! |
0 commit comments