Skip to content

Commit 4770f39

Browse files
committed
Commit 1 - Initial
0 parents  commit 4770f39

19 files changed

+14743
-0
lines changed

.gitignore

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# See http://help.github.com/ignore-files/ for more about ignoring files.
2+
3+
# compiled output
4+
/dist
5+
/tmp
6+
/out-tsc
7+
# Only exists if Bazel was run
8+
/bazel-out
9+
10+
# dependencies
11+
**/node_modules
12+
13+
# profiling files
14+
chrome-profiler-events.json
15+
speed-measure-plugin.json
16+
17+
# IDEs and editors
18+
/.idea
19+
.project
20+
.classpath
21+
.c9/
22+
*.launch
23+
.settings/
24+
*.sublime-workspace
25+
26+
# IDE - VSCode
27+
.vscode/*
28+
!.vscode/settings.json
29+
!.vscode/tasks.json
30+
!.vscode/launch.json
31+
!.vscode/extensions.json
32+
.history/*
33+
34+
# misc
35+
/.sass-cache
36+
/connect.lock
37+
/coverage
38+
/libpeerconnection.log
39+
npm-debug.log
40+
yarn-error.log
41+
testem.log
42+
/typings
43+
44+
# System Files
45+
.DS_Store
46+
Thumbs.db
47+
**/.DS_Store
48+
*.pyc
49+
**/migrations/*
50+
**/caches/*

entity-relationship/.env

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
PORT=8301
2+
BROWSER=none

entity-relationship/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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 /> ![Screenshot](https://dapulse-res.cloudinary.com/image/upload/w_900/v1591485466/remote_mondaycom_static/developers/screenshots/final_view.gif)
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

Comments
 (0)