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
If this fails with an error message, you can [have a look at GitHub HTTPS cloning errors](https://help.github.com/articles/https-cloning-errors/).
40
+
If this fails with an error message, you can [have a look at GitHub HTTPS cloning errors](https://help.github.com/articles/https-cloning-errors/).
41
41
42
-
2. Navigate to the electric-iodirectory:
42
+
2. Navigate to the electric-iodirectory:
43
43
44
-
```
45
-
cd electric-io
46
-
```
44
+
```
45
+
cd electric-io
46
+
```
47
47
48
-
3. Install electric-io’s dependencies:
48
+
3. Install electric-io’s dependencies:
49
49
50
-
```
51
-
npm install
52
-
```
50
+
```
51
+
npm install
52
+
```
53
53
54
-
If this fails with an error message, you can [have a look at common NPM errors](https://docs.npmjs.com/common-errors).
54
+
If this fails with an error message, you can [have a look at common NPM errors](https://docs.npmjs.com/common-errors).
55
55
56
56
4. Open the file `.env` in and fill in the `CONNECTION_STRING` property with your Azure IoT Hub connection string.
57
57
5. Optional. Specify the `CONSUMER_GROUP` in `.env`. _If in doubt, you can skip this step_.
58
58
6. Go back to your terminal and start electric-io:
59
59
60
-
```
61
-
npm start
62
-
```
60
+
```
61
+
npm start
62
+
```
63
63
64
64
7. Navigate to `http://localhost:3000` in your favourite modern browser and away you go! Try adding new cards via the settings pane on the right and click “edit” to fill in the details.
65
65
@@ -71,11 +71,11 @@ This application also features a simulator that features three “devices” tha
71
71
2. Navigate to the `.data` directory where you’ll note a file called `dashboard.json.sim`. Copy this file to the same directory and name it `dashboard.json`. This will set you up with a pre-made dashboard layout with some cards already listening to data from the simulated devices 😎
72
72
3. In your terminal, run:
73
73
74
-
```
75
-
SIMULATING=true npm start
76
-
```
74
+
```
75
+
SIMULATING=true npm start
76
+
```
77
77
78
-
On Windows, run `set SIMULATING=true`, then run `npm start`.
78
+
On Windows, run `set SIMULATING=true`, then run `npm start`.
79
79
80
80
4. Navigate to `http://localhost:3000` in your favourite modern browser and away you go!
81
81
@@ -88,8 +88,8 @@ Example payload:
88
88
89
89
```json
90
90
{
91
-
"temperature": 25.8976,
92
-
"humidity": 40.679
91
+
"temperature": 25.8976,
92
+
"humidity": 40.679
93
93
}
94
94
```
95
95
@@ -102,8 +102,8 @@ Example payload:
102
102
103
103
```json
104
104
{
105
-
"light": 0.45689,
106
-
"sound": 0.23878
105
+
"light": 0.45689,
106
+
"sound": 0.23878
107
107
}
108
108
```
109
109
@@ -116,7 +116,7 @@ Example payload:
116
116
117
117
```json
118
118
{
119
-
"coolness": 98.56
119
+
"coolness": 98.56
120
120
}
121
121
```
122
122
@@ -126,9 +126,9 @@ ESLint is installed by default with this repository, and many IDEs will automati
126
126
127
127
This said, some caveats remain in order to keep this approachable:
128
128
129
-
- Target NodeJS 10+
130
-
- Stick to plain CSS. SASS/SCSS is probably a little much for this project anyway.
131
-
- Idiomatic Vue style. This is way less scary than it might sound. Just keep things looking like the documentation. 🌻
129
+
-Target NodeJS 10+
130
+
-Stick to plain CSS. SASS/SCSS is probably a little much for this project anyway.
131
+
-Idiomatic Vue style. This is way less scary than it might sound. Please keep things looking like the documentation. 🌻
132
132
133
133
If you want a build toolchain for doing extra things like SASS or Vue related transpiling, go for it! But please do this in your own fork and keep it as your own project rather than trying to change this one 💜
134
134
@@ -146,7 +146,7 @@ Mobile support for this app is not great at the moment. I’d suggest the follow
146
146
2. Larger “edit” and “delete” buttons on mobile.
147
147
3. Settings can be an expandable menu item (really this should be a thing for the desktop version)
148
148
149
-
Just some ideas ✨ Add your own if you geek out about mobile responsive designs!
149
+
Some ideas ✨ Add your own if you geek out about mobile responsive designs!
150
150
151
151
## Pull requests
152
152
@@ -162,7 +162,7 @@ Then, check out a new branch with `git checkout -b my-branch-name`
162
162
163
163
Create your code / documentation changes in this branch, and commit when done. Once done, `git push fork your-branch-name`
164
164
165
-
Once this is finished pushing, you can go to your fork on GitHub. It should now ask you right away if you want to create a pull request. Clicking that button should set you up with a text field just like when creating a new issue on GitHub. Fill it out and submit the pull request. Then, we can review it “Pull requests” in this original repository.
165
+
Once this is finished pushing, you can go to your fork on GitHub. It should now ask you right away if you want to create a pull request. Clicking that button should set you up with a text field similar to when creating a new issue on GitHub. Fill it out and submit the pull request. Then, we can review it “Pull requests” in this original repository.
166
166
167
167
### Merge Conflicts
168
168
@@ -183,10 +183,10 @@ git merge master
183
183
184
184
This will:
185
185
186
-
- Switch to your own `master` branch
187
-
- Download changes from the primary repository `noopkat/electric-io`
188
-
- Switch back to your `feature/...` or `issue/...` branch
189
-
- Merge changes into your branch
186
+
-Switch to your own `master` branch
187
+
-Download changes from the primary repository `noopkat/electric-io`
188
+
-Switch back to your `feature/...` or `issue/...` branch
189
+
-Merge changes into your branch
190
190
191
191
You can then `git push` to update the PR if you’ve already submitted one.
0 commit comments