Merge pull request #369 from drone/drone2

Merging drone2 branch into master

Author: Dan Wilson

.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

.env.example

@@ -0,0 +1,8 @@
+# ENV Variables
+REACT_APP_DRONE_SERVER=
+REACT_APP_DRONE_TOKEN=
+
+# For macOS and Linux
+SASS_PATH=node_modules:src
+# For Windows
+SASS_PATH=./node_modules;./src

.eslintrc.json

@@ -0,0 +1,41 @@
+{
+  "extends": ["react-app", "airbnb", "airbnb/hooks", "airbnb/whitespace"],
+  "rules": {
+    "max-len": [1, {
+      "code": 120,
+      "ignoreTemplateLiterals": true,
+      "ignoreComments": true
+    }],
+    "jsx-a11y/label-has-associated-control": [2, {
+      "assert": "htmlFor"
+    }],
+    "react/jsx-props-no-spreading": "off",
+    "react/jsx-sort-props": [
+      "warn",
+      {
+        "callbacksLast": true,
+        "shorthandLast": true,
+        "noSortAlphabetically": true
+      }
+    ],
+    "import/order": [
+      "warn",
+      {
+        "groups": ["builtin", "external", "internal", "parent", "sibling", "index"],
+        "newlines-between": "always",
+        "alphabetize": {
+          "order": "asc",
+          "caseInsensitive": true
+        }
+      }
+    ],
+    "import/prefer-default-export": "off"
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "moduleDirectory":["node_modules", "src/"]
+      }
+    }
+  }
+}

.gitignore

@@ -1,7 +1,33 @@
-node_modules
-dist/files/*
-*.txt
-*.log
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+/dist/files
+/dist/*_gen.go
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+/.vscode
+
+# .git
+.eslintcache
+
 .env
-.env.*
-hermione
+.env.development.local
+.env.local

.huskyrc.json

@@ -0,0 +1,3 @@
+{
+  "hooks": {}
+}

.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+  "*.{js,jsx}": "eslint --fix --ignore-path .gitignore",
+  "*.{css,sass,scss,md,html}": "stylelint --fix --ignore-path .gitignore"
+}

.stylelintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": [
+    "stylelint-config-standard",
+    "stylelint-config-recommended-scss",
+    "stylelint-config-css-modules",
+    "stylelint-config-recess-order"
+  ],
+  "rules": {
+    "no-descending-specificity": null,
+    "at-rule-no-unknown": null,
+    "scss/at-rule-no-unknown": [
+      true,
+      {
+        "ignoreAtRules": ["value"]
+      }
+    ]
+  }
+}

README.md

@@ -1,35 +1,70 @@
-# drone-ui
+## Drone UI
 
-## Configuration
+### Getting started
 
-Create a `.env.development.local` file with the drone server address (no trailing slash) and your drone user token:
+1. **Clone this repository**
 
-```
-VUE_APP_DRONE_SERVER=https://drone.company.com
-VUE_APP_DRONE_TOKEN=f0af17449a83681de22db7ce16672f16
-```
+   ```bash
+   git clone https://github.com/drone/drone-ui.git
+   ```
 
-## Project setup
-```
-npm install
+2. **Install dependencies**
+
+   ```bash
+   npm install
+   ```
+
+3. **Copy .env.example and rename it into .env**
+
+   ```bash
+   cp .env.example .env.development.local
+   ```
+
+4. **Fill required variables. For example:**
+
+   ```text
+   REACT_APP_DRONE_SERVER=https://drone.company.com
+   REACT_APP_DRONE_TOKEN=<your_drone_token>
+   ```
+
+### Run the app
+
+```bash
+npm run start
 ```
 
-### Compiles and hot-reloads for development
+### Build the app
+
+```bash
+npm run build
 ```
+
+### Run the built app
+
+```bash
 npm run serve
 ```
 
-### Compiles and minifies for production
+### Run linters
+
+```bash
+npm run lint
 ```
-npm run build
+
+### Run linters and fix auto fixable problems
+
+```bash
+npm run lint:fix
 ```
 
 ### Run your tests
-```
+
+```bash
 npm run test
 ```
 
-### Lints and fixes files
-```
-npm run lint
-```
+## Commits
+
+We use Conventional Commits for commit messages. You can read more about Conventional Commits [here](https://www.conventionalcommits.org/en/v1.0.0/). [Here](https://cheatography.com/albelop/cheat-sheets/conventional-commits/) you can find a useful Conventional Commits Cheat Sheet.
+
+We try to make our commits "atomic". [Here](https://www.freshconsulting.com/atomic-commits/) and [here](https://en.wikipedia.org/wiki/Atomic_commit) you can read more about Atomic commits.

babel.config.js

@@ -1,4 +1,3 @@
 package dist
 
 //go:generate togo http -package dist -output dist_gen.go
-