https://github.com/ellemenno/prets

fencing timing trainer
https://github.com/ellemenno/prets

Last synced: 1 day ago
JSON representation

fencing timing trainer

• Host: GitHub
• URL: https://github.com/ellemenno/prets
• Owner: ellemenno
• License: mit
• Created: 2024-06-23T16:57:52.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-24T00:52:38.000Z (about 2 months ago)
• Last Synced: 2024-11-24T01:30:13.229Z (about 2 months ago)
• Language: Shell
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# prets

fencing timing trainer

> https://ellemenno.xyz/prets

## development

to collect and serve the site files for testing via [localhost]:

```console

$ ./run.sh serve`

```

## publishing

this site is hosted via GitHub Pages from the [`gh-pages`][gh-pages] branch, tracked as a separate [git worktree] rooted at this directory.

to set up for publishing:

1. create a new [Personal Access Token][pat] on GitHub ([instructions][pat howto])

   - _Repository access | Only select repositories_

   - _Contents: Reand and Write_

1. add an untracked config file to this repo (`.env`):

   - `$ printf "DEPLOY_USER=uuu\nDEPLOY_TOKEN=ttt\nQUERY_TOKEN=$DEPLOY_TOKEN" > .env`

   - _(replace `uuu` and `ttt` with your username and personal access token)_

   - _note `QUERY_TOKEN` could also be a different PAT; it only needs "Deployments" repository permissions (read)_

   - _`.env` should be kept out of source control to protect your secrets_

1. run the publish task

   - `./run.sh publish`

[gh-pages]: https://github.com/ellemenno/vbstats/tree/gh-pages "branch for GitHub Pages auto-deployments"

[git worktree]: https://git-scm.com/docs/git-worktree "git command to manage multiple working trees"

[localhost]: http://localhost:8080/ "local testing url"

[pat]: https://github.com/settings/personal-access-tokens/new "GitHub personal access tokens"

[pat howto]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token "creating a personal access token"

[X1011]: https://github.com/X1011/git-directory-deploy "method for deploying a sub-directory of build files"