Merge pull request #1 from saltcandy123/develop

Add prototype

Author: saltcandy123

.github/workflows/github-pages.yml

@@ -0,0 +1,43 @@
+name: GitHub Pages
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+
+jobs:
+  build:
+    name: Build GitHub Pages
+    # Ubuntu 20.04 or later is required for python3-fontforge
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v2
+      with:
+        node-version: '14'
+    - name: Install FontForge
+      run: sudo apt-get install fontforge python3-fontforge
+    - name: Build fonts
+      run: python3 build_fonts.py --tag ${{ github.sha }}
+    - name: Build webapp
+      run: |
+        export NEXTJS_BASE_PATH=$(echo $GITHUB_REPOSITORY | sed -e 's@.*/\(.*\)@\/\1@')
+        cd webapp
+        yarn
+        yarn run build
+    - name: Add miscellaneous files into /webapp-dist
+      run: |
+        cd webapp-dist/
+        touch .nojekyll
+        fontimage ../font-dist/saltcandy123font.ttf -o sample.png
+    - name: Publish GitHub Pages
+      run: |
+        mv .git webapp-dist/
+        cd webapp-dist/
+        git checkout --orphan gh-pages
+        git add .
+        git config user.email "saltcandy123@gmail.com"
+        git config user.name "saltcandy123 (GitHub Actions)"
+        git commit -m 'publish GitHub Pages (source commit: ${{ github.sha }})'
+        git push origin gh-pages -f

.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+
+jobs:
+  build-font:
+    name: Build fonts
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install FontForge
+      run: sudo apt-get install fontforge python3-fontforge
+    - name: Build fonts
+      run: python3 build_fonts.py --tag ${{ github.ref }}
+    - name: Create release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: ${{ github.ref }}
+    - name: Upload saltcandy123font.ttf
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: font-dist/saltcandy123font.ttf
+        asset_name: saltcandy123font.ttf
+        asset_content_type: font/ttf
+    - name: Upload saltcandy123font.woff
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: font-dist/saltcandy123font.woff
+        asset_name: saltcandy123font.woff
+        asset_content_type: font/woff
+    - name: Upload saltcandy123font.woff2
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: font-dist/saltcandy123font.woff2
+        asset_name: saltcandy123font.woff2
+        asset_content_type: font/woff2

.github/workflows/verification.yml

@@ -0,0 +1,52 @@
+name: Verification
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Build fonts and demo pages
+    # Ubuntu 20.04 or later is required for python3-fontforge
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v2
+      with:
+        node-version: '14'
+    - name: Lint glyph SVG files
+      run: |
+        python3 utils/clean_glyphs.py glyphs/
+        git diff --numstat --exit-code
+    - name: Install FontForge
+      run: sudo apt-get install fontforge python3-fontforge
+    - name: Build fonts
+      run: python3 build_fonts.py --tag ${{ github.sha }}
+    - name: Archive font-dist
+      uses: actions/upload-artifact@v2
+      with:
+        name: font-dist
+        path: font-dist
+    - name: Build webapp
+      run: |
+        cd webapp
+        yarn
+        yarn run lint
+        yarn run build
+    - name: Archive webapp-dist
+      uses: actions/upload-artifact@v2
+      with:
+        name: webapp-dist
+        path: webapp-dist
+  super-linter:
+    name: Run Super-Linter
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run Super-Linter
+      uses: github/super-linter@v3
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        FILTER_REGEX_EXCLUDE: .*/glyphs/.*|.*/webapp/.*\.(jsx?|tsx?)

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+.next
+/font-dist
+/webapp-dist
+yarn-error.log

README.md

@@ -1,2 +1,27 @@
 # saltcandy123font
-A simple handwritten font created by @saltcandy123
+
+@saltcandy123 による手書きフォントです。
+
+This is a simple handwritten font created by @saltcandy123.
+
+* Download font from <https://github.com/saltcandy123/saltcandy123font/releases>
+* Try out demo on <https://saltcandy123.github.io/saltcandy123font/>
+
+![Sample image](https://saltcandy123.github.io/saltcandy123font/sample.png)
+
+## How it works
+
+All the glyph data is stored as SVG files in [`/glyphs`](./glyphs) directory.
+Each SVG file is named after the corresponding 4-digit hex Unicode.
+For instance, the filename for "A" glyph should be [`u0041.svg`](./glyphs/u0041.svg) because the Unicode of "A" is 41 in hex.
+See also [Unicode Character Code Charts](https://unicode.org/charts/).
+
+A Python script [`/build_fonts.py`](./build_fonts.py) converts the SVG files to fonts in `/font-dist` directory.
+It requires [FontForge](https://fontforge.org/) and [its Python library](https://fontforge.org/docs/scripting/python.html).
+
+[`/webapp`](./webapp) is the source code directory for <https://saltcandy123.github.io/saltcandy123font/>.
+`yarn && yarn build` builds static pages in `/webapp-dist` directory.
+`yarn build` requires `/font-dist` directory with font files.
+
+Releasing is handled by GitHub Actions.
+By pushing a tag to this repository, GitHub Actions will automatically [create a new release](./.github/workflows/release.yml) and [update GitHub Pages](./.github/workflows/github-pages.yml).

build_fonts.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+import argparse
+import pathlib
+import re
+import xml.dom.minidom
+
+import fontforge
+
+BASE_DIR = pathlib.Path(__file__).parent
+
+
+def build_saltcandy123font(*, tag):
+    font = fontforge.font()
+    font.familyname = "saltcandy123font"
+    font.fullname = "saltcandy123font-Regular"
+    font.fontname = font.fullname
+    font.copyright = "Copyright (C) saltcandy123"
+    font.weight = "Regular"
+    font.os2_weight = 400
+    if tag:
+        font.version = tag
+
+    for svg_path in BASE_DIR.joinpath("glyphs").iterdir():
+        match = re.search("^u([0-9a-f]{4}).svg$", svg_path.name)
+        if not match:
+            continue
+        code = int(match.group(1), 16)
+        glyph = font.createChar(code)
+        glyph.importOutlines(str(svg_path))
+        with xml.dom.minidom.parse(str(svg_path)) as doc:
+            glyph.width = int(doc.childNodes[0].getAttribute("width"))
+    return font
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--tag")
+    args = parser.parse_args()
+
+    dist_dir = BASE_DIR.joinpath("font-dist")
+    dist_dir.mkdir(exist_ok=True)
+
+    font_map = {
+        "saltcandy123font": build_saltcandy123font(tag=args.tag),
+    }
+    for font_name in font_map:
+        font = font_map[font_name]
+        for ext in ["ttf", "woff", "woff2"]:
+            font.generate(str(dist_dir.joinpath(f"{font_name}.{ext}")))
+
+
+if __name__ == "__main__":
+    main()