Setup repo and CI

* Setup and test CI * Fix new line * Lock node version * Fix new line and add PR template * Address feedback * Remove unused files
Dioliode · Oct 19, 2023 · ed7b130 · ed7b130
1 parent 0d3cab1
commit ed7b130
Show file tree

Hide file tree

Showing 20 changed files with 198 additions and 232 deletions.
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,11 @@
+## Summary
+
+## Detail
+
+## Testing
+
+## Documentation
+
+---
+
+**Requested Reviewers:** @mention
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,27 @@
+name: Continuous Integration
+on:
+  pull_request:
+
+jobs:
+  run_ci_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Install Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.14.0"
+
+      - name: Install Yarn
+        run: npm install -g [email protected]
+
+      - name: Install packages
+        run: yarn install --frozen-lockfile
+
+      - name: Setup local environment
+        run: cp config.js.example config.js && ./start-ganache.sh
+
+      - name: Run tests
+        run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,12 @@ validate/apikey.infura
 ganache-blockchain-log.txt
 .coverage_artifacts
 .coverage_contracts
-yarn-error.log
 @types/generated/
 config.js
+
+# Yarn & Node Modules
+yarn-error.log
+node_modules/
+
+logs/
+pids/
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn precommit
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v16.14.0
diff --git a/.travis.yml b/.travis.yml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,8 +1,4 @@
 {
-  "files.exclude": {
-    "**/.DS_Store": true,
-    "**/node_modules/": true
-  },
   "solidity.packageDefaultDependenciesContractsDirectory": "",
   "solidity.packageDefaultDependenciesDirectory": "node_modules",
   "solidity.formatter": "none",

diff --git a/Dockerfile.ganache b/Dockerfile.ganache
diff --git a/Dockerfile.truffle b/Dockerfile.truffle
diff --git a/README.md b/README.md
@@ -12,9 +12,9 @@ Requirements:
 ```
 $ git clone [email protected]:centrehq/centre-tokens.git
 $ cd centre-tokens
-$ npm i -g yarn       # Install yarn if you don't already have it
-$ yarn install        # Install dependencies
-$ yarn setup          # Setup Git hooks
+$ nvm use
+$ npm i -g [email protected] # Install yarn if you don't already have it
+$ yarn install          # Install dependencies
 ```
 
 ## TypeScript type definition files for the contracts

diff --git a/build-dev.sh b/build-dev.sh
diff --git a/buildspec.yaml b/buildspec.yaml
diff --git a/ci/codebuild.yaml b/ci/codebuild.yaml
diff --git a/docker-compose.yml b/docker-compose.yml
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
     "test": "test"
   },
   "scripts": {
-    "setup": "git config core.hooksPath .githooks",
+    "prepare": "husky install",
     "compile": "truffle compile",
     "typechain": "yarn compile && rm -rf './@types/generated' && typechain --target=truffle-v5 --outDir './@types/generated' 'build/contracts/**/*.json'",
     "typecheck": "tsc -p . --noEmit",
@@ -58,6 +58,7 @@
     "ethereumjs-util": "^7.0.3",
     "ganache-cli": "^6.12.2",
     "googleapis": "^55.0.0",
+    "husky": "^8.0.3",
     "lodash": "^4.17.19",
     "prettier": "2.0.5",
     "prettier-plugin-solidity": "1.0.0-alpha.54",
@@ -72,7 +73,7 @@
     "web3": "^1.2.11"
   },
   "engines": {
-    "node": ">= 12.0.0",
-    "yarn": ">= 1.21.1"
+    "node": "16.14.0",
+    "yarn": "1.22.19"
   }
 }
diff --git a/scripts/verify-environment.sh b/scripts/verify-environment.sh