Initial commit

Author: Joeysantoro

.github/workflows/CI.yml

@@ -0,0 +1,28 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  run-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: actions/setup-node@v2
+      - name: Install dev dependencies
+        run: npm install
+
+      - name: Install Foundry
+        uses: onbjerg/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run lint check
+        run: npm run lint:check
+
+      - name: Run tests
+        run: forge test

.gitignore

@@ -0,0 +1,4 @@
+out/
+cache/
+node_modules/
+.env

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "lib/ds-test"]
+	path = lib/ds-test
+	url = https://github.com/dapphub/ds-test
+[submodule "lib/solmate"]
+	path = lib/solmate
+	url = https://github.com/Rari-Capital/solmate
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/brockelmore/forge-std

.solhint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "solhint:recommended", 
+  "rules": {
+    "compiler-version": ["error",">=0.8.0"], 
+    "avoid-low-level-calls": "off"
+  }
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "editor.formatOnSave": true,
+    "solidity.formatter": "prettier",
+    "[solidity]": {
+        "editor.defaultFormatter": "JuanBlanco.solidity"
+    }
+}

README.md

@@ -0,0 +1,46 @@
+# Forge Template
+
+A template for quickly getting started with forge
+
+## Getting Started
+
+```
+mkdir my-project
+cd my-project
+forge init --template https://github.com/FrankieIsLost/forge-template
+git submodule update --init --recursive  ## initialize submodule dependencies
+npm install ## install development dependencies
+forge build
+forge test
+```
+
+## Features
+
+### Testing Utilities
+
+Includes a `Utilities.sol` contract with common testing methods (like creating users with an initial balance), as well as various other utility contracts.
+
+### Preinstalled dependencies
+
+`ds-test` for testing, `forge-std` for better cheatcode UX, and `solmate` for optimized contract implementations.  
+
+### Linting
+
+Pre-configured `solhint` and `prettier-plugin-solidity`. Can be run by
+
+```
+npm run solhint
+npm run prettier
+```
+
+### CI with Github Actions
+
+Automatically run linting and tests on pull requests.
+
+### Default Configuration
+
+Including `.gitignore`, `.vscode`, `remappings.txt`
+
+## Acknowledgement
+
+Inspired by great dapptools templates like https://github.com/gakonst/forge-template, https://github.com/gakonst/dapptools-template and https://github.com/transmissions11/dapptools-template