Merge pull request #44 from nation3/link-a-profile-to-github-22

Link a profile to GitHub #22

Author: aahna-ashina

.env.local.sample

@@ -0,0 +1,3 @@
+GITHUB_CALLBACK_BASE_URL=http://localhost:3000
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=

.gitignore

@@ -25,7 +25,7 @@ yarn-debug.log*
 yarn-error.log*
 
 # local env files
-.env*.local
+.env.local
 
 # vercel
 .vercel

README.md

@@ -2,6 +2,30 @@
 
 A directory of Nation3 Citizens and their profiles
 
+## Environment Variables
+
+### GitHub OAuth App
+
+How to create a new OAuth App:
+
+1. Go to https://github.com/organizations/nation3/settings/applications
+
+1. Click "New OAuth App"
+
+   - Application name: Nation3 Citizen Directory
+
+   - Homepage URL: https://citizens.nation3.org
+
+   - Authorization callback URL: https://citizens.nation3.org
+
+### `.env.local`
+
+Add the GitHub environment variables to `.env.local`:
+
+```
+cp .env.local.sample .env.local
+```
+
 ## Build
 
 ```

abis/GitHub.json

@@ -0,0 +1,31 @@
+{
+	"abi": [{
+		"inputs": [],
+		"stateMutability": "nonpayable",
+		"type": "constructor"
+	}, {
+		"inputs": [{
+			"internalType": "string",
+			"name": "username",
+			"type": "string"
+		}],
+		"name": "updateUsername",
+		"outputs": [],
+		"stateMutability": "nonpayable",
+		"type": "function"
+	}, {
+		"inputs": [{
+			"internalType": "address",
+			"name": "",
+			"type": "address"
+		}],
+		"name": "usernames",
+		"outputs": [{
+			"internalType": "string",
+			"name": "",
+			"type": "string"
+		}],
+		"stateMutability": "view",
+		"type": "function"
+	}]
+}