Fetch Dates from Github (#96)

* clean up code

* update project decoder

* Setup project year stuff

* use githubRepo field instead of githubLink

* store github repo instead of link

* Fix typo

* [refactor] split `RawData` and `ProcessedData` for better extensibility

* Use gihtub API to get date ranges

* fix ptable github repo

* Read `GITHUB_TOKEN` env when building

* ue `dotenvx` to handle script-level loading of env files

Author: joshuanianji

.github/workflows/deploy.yml

@@ -42,7 +42,9 @@ jobs:
 
     - name: Build
       run: pnpm build
-    
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
     - name: Add `static/` to `dist/`
       run: mv static/* dist
 

.gitignore

@@ -5,4 +5,6 @@ dist/
 functions/render/elm-pages-cli.js
 
 .DS_Store
-.pnpm-store
+.pnpm-store
+
+.env

README.md

@@ -8,5 +8,21 @@ Open up the project in a devcontainer, then run the following
 
 ```
 pnpm i
+touch .env
 pnpm dev
 ```
+
+## Environment Variables
+
+Create a `.env` file in the root of the project with the following variables.
+
+```env
+# optional - if you want to increase the rate limit for the GitHub API
+GITHUB_TOKEN=your_github_pat
+```
+
+### `GITHUB_TOKEN`
+
+My website uses the GitHub API to fetch data in my public repos. The calls should be cached but sometimes in development you might hit the rate limit. To increase the limit you can create a personal access token and add it to the `.env` file.
+
+A PAT with read-only access to public repos is sufficient.

app/Route/Index.elm

@@ -17,7 +17,7 @@ import Icon
 import Icosahedron
 import Pages.Url
 import PagesMsg exposing (PagesMsg)
-import Project exposing (Language, Project)
+import Project exposing (Project)
 import Route
 import RouteBuilder exposing (App, StatefulRoute)
 import Shared

package.json

@@ -3,11 +3,12 @@
   "type": "module",
   "scripts": {
     "postinstall": "elm-tooling install",
-    "dev": "elm-pages dev",
+    "dev": "dotenvx run -- elm-pages dev",
     "build": "elm-pages build",
     "serve": "pnpm build && http-server ./dist -a localhost -p 3000 -c-1"
   },
   "devDependencies": {
+    "@dotenvx/dotenvx": "^0.37.0",
     "elm-codegen": "0.5.3",
     "elm-optimize-level-2": "0.3.5",
     "elm-pages": "3.0.12",