Merge pull request #564 from nervosnetwork/rc/v0.1.0-alpha.0

[ᚬmaster] RC v0.1.0 alpha.0

Author: ashchan

.editorconfig

@@ -0,0 +1,46 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# Use 4 spaces for the Python files
+[*.py]
+indent_size = 4
+max_line_length = 120
+
+# The JSON files contain newlines inconsistently
+[*.json]
+insert_final_newline = ignore
+
+# The JavaScript file
+[*.js]
+indent_size = 2
+max_line_length = 120
+
+# The TypeScript file
+[*.{ts,tsx}]
+indent_size = 2
+trim_trailing_whitespace = true
+max_line_length = 120
+
+# Minified JavaScript files shouldn't be changed
+[**.min.js]
+indent_style = ignore
+insert_final_newline = ignore
+
+# Makefiles always use tabs for indentation
+[Makefile]
+indent_style = tab
+
+# Batch files use tabs for indentation
+[*.bat]
+indent_style = tab
+
+[*.md]
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1 @@
+jest.config.js

.eslintrc.js

@@ -0,0 +1,74 @@
+module.exports = {
+  "extends": ["airbnb", "plugin:prettier/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "prettier/prettier": [2, {
+      "printWidth": 120
+    }],
+    "semi": [2, "never"],
+    "comma-dangle": [2, {
+      "arrays": "always-multiline",
+      "objects": "always-multiline",
+      "imports": "always-multiline",
+      "exports": "always-multiline",
+      "functions": "ignore"
+    }],
+    "import/no-extraneous-dependencies": [2, {
+      "devDependencies": true
+    }],
+    "no-unused-vars": "off",
+    "implicit-arrow-linebreak": "off",
+    "@typescript-eslint/no-unused-vars": ["error", {
+      "vars": "local",
+      "args": "after-used",
+      "ignoreRestSiblings": false
+    }],
+    "arrow-parens": [2, "as-needed"],
+    "max-len": [2, {
+      "code": 120,
+      "ignoreComments": true,
+      "ignoreTrailingComments": true,
+      "ignoreUrls": true,
+      "ignoreStrings": true,
+      "ignoreTemplateLiterals": true,
+      "ignoreRegExpLiterals": true,
+    }],
+    "object-curly-newline": ["error", {
+      "ObjectExpression": {
+        "consistent": true
+      },
+      "ObjectPattern": {
+        "consistent": true
+      },
+      "ImportDeclaration": {
+        "consistent": true,
+      },
+      "ExportDeclaration": {
+        "multiline": true,
+        "minProperties": 3
+      }
+    }],
+    "no-plusplus": [0],
+    "no-console": [2, {
+      "allow": ["warn", "error", "info"]
+    }],
+    "lines-between-class-members": ["error", "always", { exceptAfterSingleLine: true }]
+  },
+  "globals": {
+    "BigInt": "readonly"
+  },
+  "env": {
+    "jest": true,
+    "browser": true,
+    "node": true
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "paths": ["src"],
+        "extensions": [".js", ".jsx", ".ts", ".tsx"]
+      }
+    }
+  }
+};

.gitignore

@@ -0,0 +1,46 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+build
+dist
+pages
+release
+
+# misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+*.log
+
+# deps lock
+# yarn-lock.json
+package-lock.json
+lerna-debug.log
+
+#docs
+docs
+
+# vscode config
+./packages/neuron-wallet/.vscode
+
+# Webstorm config
+.idea
+
+# sqlite db
+cell-dev.sqlite
+address-dev.sqlite

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "es5",
+  "semi": false,
+  "singleQuote": true
+}

.travis.yml

@@ -0,0 +1,32 @@
+language: node_js
+
+os:
+  - linux
+  - osx
+
+dist: xenial
+osx_image: xcode10.2
+
+services:
+  - xvfb
+
+node_js:
+  - '11'
+  - '12'
+
+cache:
+  - npm
+  - yarn
+
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.13.0
+  - export PATH=$HOME/.yarn/bin:$PATH
+  - yarn global add lerna
+
+install:
+  - travis_retry yarn bootstrap
+
+script:
+  - git diff --exit-code yarn.lock
+  - CI=false yarn build
+  - yarn test

.vscode/launch.json

@@ -0,0 +1,27 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [{
+    "name": "Chrome",
+    "type": "chrome",
+    "request": "launch",
+    "url": "http://localhost:3000",
+    "webRoot": "${workspaceRoot}/packages/neuron-ui/src"
+  }, {
+    "name": "neuron-wallet",
+    "type": "node",
+    "request": "launch",
+    "cwd": "${workspaceRoot}/packages/neuron-wallet",
+    "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
+    "windows": {
+      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd"
+    },
+    "args": ["."],
+    "outputCapture": "std",
+    "env": {
+      "NODE_ENV": "development"
+    }
+  }]
+}

.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+  "eslint.workingDirectories": [
+    {
+      "directory": "packages/neuron-wallet",
+      "changeProcessCWD": true
+    },
+    {
+      "directory": "packages/neuron-ui",
+      "changeProcessCWD": true
+    }
+  ],
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

.yarnrc

@@ -0,0 +1 @@
+registry "https://registry.yarnpkg.com"

README.md

@@ -1,2 +1,71 @@
 # Neuron
+
 Nervos CKB Wallet
+
+[![Azure Pipelines Build Status](https://dev.azure.com/nervosnetwork/neuron/_apis/build/status/nervosnetwork.neuron?branchName=develop)](https://dev.azure.com/nervosnetwork/neuron/_build/latest?definitionId=8&branchName=develop)
+[![TravisCI](https://travis-ci.com/nervosnetwork/neuron.svg?branch=develop)](https://travis-ci.com/nervosnetwork/neuron)
+[![Telegram Group](https://cdn.rawgit.com/Patrolavia/telegram-badge/8fe3382b/chat.svg)](https://t.me/nervos_ckb_dev)
+
+---
+
+## Quick Start
+
+### Prerequisites
+
+You will need `node >= 11` and `yarn >= 1.12` to build and run this Neuron.
+
+Please be noted that Neuron depends on [node-gyp](https://github.com/nodejs/node-gyp) to build native NPM modules. Follow [this](https://github.com/nodejs/node-gyp#installation) to install node-gyp dependencies.
+
+#### Lerna
+
+Neuron project uses [lerna](https://github.com/lerna/lerna/) for packages management. It can be installed globally, or locally in the project.
+
+```sh
+$ yarn global add lerna # install lerna globally
+# or
+$ yarn add lerna --exact --ignore-workspace-root-check # install lerna locally in the project
+```
+
+#### Install Dependencies
+
+After lerna installed, the dependencies can be installed by
+
+```sh
+$ yarn bootstrap
+```
+
+### Start Neuron
+
+### Start Neuron in development mode
+
+```sh
+$ yarn start
+```
+
+This command will start two tasks
+
+1. start `neuron-ui`, which works for the user interface.
+2. start `neuron-wallet`, works for the wallet functionality.
+
+They are also able to start independently:
+
+```sh
+# start neuron-ui at `http://localhost:3000`
+$ cd packages/neuron-ui && yarn start
+```
+
+```sh
+# start neuron-wallet
+$ cd packages/neuron-wallet && yarn start:dev
+```
+
+### Test
+
+```sh
+# launch the test runner in the watch mode.
+$ yarn test
+```
+
+## License
+
+Neuron is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT).