codex-mirror's Introduction

Codex Mirror for Formosa & Pescadores

⚠️ Personal project to track changes of laws. USE AT YOUR OWN DISGRESSION.

ℹ️ Please refer to 全國法規資料庫 for the most accurate and up-to-date material.

🌐 Hosting on Github Pages https://iunn-sh.github.io/codex-mirror

dir	content	format
`raw`	downloaded and unzipped files	`.zip` / `.csv` / `.json`
`depot`	parsed data from raw	`.json`
`docs`	processed data for frontend	`.md`

Local Development

# Go: process data 
## with Docker
docker run --rm $(docker build -t codex-mirror -q .)
docker run --rm $(docker build -t codex-mirror --progress=plain --no-cache .) # debug
## with Golang (tested with 1.20)
go fmt ./...
go mod tidy
go run .

# Mkdocs Material: host frontend
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:9.5.5
# visit http://localhost:8000/ from browser

Production Deployment

Commit or merge PR to main branch

codex-mirror's People

Contributors

Watchers

codex-mirror's Issues

Create folders if not exist

AC: if target folders (raw / docs / depot) do not exist, create them then proceed on file operations.

ci#144 got connection refused when downloading zip. Hence empty folders ended up in folder deletions.

3:23AM ERR error="Get \"[https://law.moj.gov.tw/api/Ch/Law/JSON\](https://law.moj.gov.tw/api/Ch/Law/JSON/)": dial tcp 163.29.130.173:443: connect: connection refused"
3:23AM ERR error="open /home/runner/work/codex-mirror/codex-mirror/raw/ChLaw.json.zip: no such file or directory"
3:23AM ERR error="open /home/runner/work/codex-mirror/codex-mirror/raw/ChLaw.json: no such file or directory"

Enhanced search for frontend

Chinese search is not as accurate in basic package. Premium does have that function https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#chinese-language-support (actually, it is in the next funding goal https://squidfunk.github.io/mkdocs-material/insiders/#funding)

AC:

pay to be a sponsor or study workaround
switching frontend platform is also on the table

Deploy to Github Pages when there is change in ./docs

Currently, git-auto-commit Action (in cron.yml) will not trigger main.yml to prevent endless workflow https://github.com/stefanzweifel/git-auto-commit-action#commits-made-by-this-action-do-not-trigger-new-workflow-runs

Workaround for now: combine cron.yml & ci.yml, so there is a daily rebuild 39a1f27

AC:

if there are substantial changes in website content (namely ./docs/*.md), a deployment should be triggered
if there is only .zip or .json changes, ignore them