Skip to content

Commit 57beb6e

Browse files
underscoredotspacenoopkat
authored andcommitted
Adds Alex (#159)
* define browser support to last 2 years * adds Alex * remove test word * add to CI * oops
1 parent 5c87703 commit 57beb6e

File tree

6 files changed

+15063
-13255
lines changed

6 files changed

+15063
-13255
lines changed

.alexrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"allow": [
3+
"hook", "remain", "color"
4+
]
5+
}

CODE_OF_CONDUCT.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- alex disable-->
2+
13
# Contributor Code of Conduct
24

35
As contributors and maintainers of this project, and in the interest of
@@ -12,13 +14,13 @@ body size, race, ethnicity, age, religion, or nationality.
1214

1315
Examples of unacceptable behavior by participants include:
1416

15-
* The use of sexualized language or imagery
16-
* Personal attacks
17-
* Trolling or insulting/derogatory comments
18-
* Public or private harassment
19-
* Publishing other's private information, such as physical or electronic
20-
addresses, without explicit permission
21-
* Other unethical or unprofessional conduct
17+
- The use of sexualized language or imagery
18+
- Personal attacks
19+
- Trolling or insulting/derogatory comments
20+
- Public or private harassment
21+
- Publishing other's private information, such as physical or electronic
22+
addresses, without explicit permission
23+
- Other unethical or unprofessional conduct
2224

2325
Project maintainers have the right and responsibility to remove, edit, or
2426
reject comments, commits, code, wiki edits, issues, and other contributions
@@ -41,7 +43,6 @@ is deemed necessary and appropriate to the circumstances. Maintainers are
4143
obligated to maintain confidentiality with regard to the reporter of an
4244
incident.
4345

44-
4546
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
4647
version 1.3.0, available at
4748
[http://contributor-covenant.org/version/1/3/0/][version]

CONTRIBUTING.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Hey! Thanks for your interest in contributing to this project! I really apprecia
55
This page should get you up and running with how to run locally and how to adhere to this project’s style guide also.
66

77
1. [Installation](#installation)
8-
- [With a real Azure IoT Hub](#with-a-real-azure-iot-hub)
9-
- [With the device and hub simulator](#with-the-built-in-device-and-hub-simulator)
8+
- [With a real Azure IoT Hub](#with-a-real-azure-iot-hub)
9+
- [With the device and hub simulator](#with-the-built-in-device-and-hub-simulator)
1010
2. [Style guide](#style-guide)
11-
- [Tests](#tests)
12-
- [Mobile support](#mobile-support)
11+
- [Tests](#tests)
12+
- [Mobile support](#mobile-support)
1313
3. [Pull requests](#pull-requests)
14-
- [Avoiding merge conflicts](#merge-conflicts)
14+
- [Avoiding merge conflicts](#merge-conflicts)
1515

1616
## Installation
1717

@@ -31,35 +31,35 @@ You can also list your connections strings [via the command line](https://docs.m
3131
2. Install [Git](https://git-scm.org).
3232
3. Open your terminal and do the following:
3333

34-
1. Clone the [electric-io repository](https://github.com/noopkat/electric-io):
34+
1. Clone the [electric-io repository](https://github.com/noopkat/electric-io):
3535

36-
```
37-
git clone https://github.com/noopkat/electric-io.git
38-
```
36+
```
37+
git clone https://github.com/noopkat/electric-io.git
38+
```
3939
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/).
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/).
4141
42-
2. Navigate to the electric-iodirectory:
42+
2. Navigate to the electric-iodirectory:
4343
44-
```
45-
cd electric-io
46-
```
44+
```
45+
cd electric-io
46+
```
4747
48-
3. Install electric-io’s dependencies:
48+
3. Install electric-io’s dependencies:
4949
50-
```
51-
npm install
52-
```
50+
```
51+
npm install
52+
```
5353
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).
5555
5656
4. Open the file `.env` in and fill in the `CONNECTION_STRING` property with your Azure IoT Hub connection string.
5757
5. Optional. Specify the `CONSUMER_GROUP` in `.env`. _If in doubt, you can skip this step_.
5858
6. Go back to your terminal and start electric-io:
5959
60-
```
61-
npm start
62-
```
60+
```
61+
npm start
62+
```
6363
6464
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.
6565
@@ -71,11 +71,11 @@ This application also features a simulator that features three “devices” tha
7171
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 😎
7272
3. In your terminal, run:
7373
74-
```
75-
SIMULATING=true npm start
76-
```
74+
```
75+
SIMULATING=true npm start
76+
```
7777
78-
On Windows, run `set SIMULATING=true`, then run `npm start`.
78+
On Windows, run `set SIMULATING=true`, then run `npm start`.
7979
8080
4. Navigate to `http://localhost:3000` in your favourite modern browser and away you go!
8181
@@ -88,8 +88,8 @@ Example payload:
8888
8989
```json
9090
{
91-
"temperature": 25.8976,
92-
"humidity": 40.679
91+
"temperature": 25.8976,
92+
"humidity": 40.679
9393
}
9494
```
9595

@@ -102,8 +102,8 @@ Example payload:
102102

103103
```json
104104
{
105-
"light": 0.45689,
106-
"sound": 0.23878
105+
"light": 0.45689,
106+
"sound": 0.23878
107107
}
108108
```
109109

@@ -116,7 +116,7 @@ Example payload:
116116

117117
```json
118118
{
119-
"coolness": 98.56
119+
"coolness": 98.56
120120
}
121121
```
122122

@@ -126,9 +126,9 @@ ESLint is installed by default with this repository, and many IDEs will automati
126126

127127
This said, some caveats remain in order to keep this approachable:
128128

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. 🌻
132132

133133
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 💜
134134

@@ -146,7 +146,7 @@ Mobile support for this app is not great at the moment. I’d suggest the follow
146146
2. Larger “edit” and “delete” buttons on mobile.
147147
3. Settings can be an expandable menu item (really this should be a thing for the desktop version)
148148

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!
150150

151151
## Pull requests
152152

@@ -162,7 +162,7 @@ Then, check out a new branch with `git checkout -b my-branch-name`
162162

163163
Create your code / documentation changes in this branch, and commit when done. Once done, `git push fork your-branch-name`
164164

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.
166166

167167
### Merge Conflicts
168168

@@ -183,10 +183,10 @@ git merge master
183183

184184
This will:
185185

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
190190

191191
You can then `git push` to update the PR if you’ve already submitted one.
192192

azure-pipelines.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@
44
# https://docs.microsoft.com/azure/devops/pipelines/languages/javascript
55

66
trigger:
7-
- master
7+
- master
88

99
pool:
10-
vmImage: 'ubuntu-16.04'
10+
vmImage: "ubuntu-16.04"
1111

1212
strategy:
13-
matrix:
14-
node_8_x:
15-
node_version: 8.x
16-
node_9_x:
17-
node_version: 9.x
18-
node_10_x:
19-
node_version: 10.x
20-
node_11_x:
21-
node_version: 11.x
13+
matrix:
14+
node_8_x:
15+
node_version: 8.x
16+
node_9_x:
17+
node_version: 9.x
18+
node_10_x:
19+
node_version: 10.x
20+
node_11_x:
21+
node_version: 11.x
2222

2323
steps:
24-
- task: NodeTool@0
25-
inputs:
26-
versionSpec: $(node_version)
24+
- task: NodeTool@0
25+
inputs:
26+
versionSpec: $(node_version)
2727

28-
29-
- script: |
30-
npm install
31-
npm test
32-
displayName: 'npm install and test'
28+
- script: |
29+
npm install
30+
npm test
31+
npm run alex
32+
displayName: "npm install, test, and Alex lint"

0 commit comments

Comments
 (0)