From d1b01fb422aca2779e773f01dc77fa33109fbc22 Mon Sep 17 00:00:00 2001 From: Mark Bools Date: Sat, 24 Aug 2024 18:52:24 +0100 Subject: [PATCH] Add articles associated with module development youtube --- .../index.md | 18 +++++++++++++ .../fvtt-mod-dev-local-project-setup/index.md | 25 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 mondarth-com/content/post/fvtt-mod-dev-github-repository-setup/index.md create mode 100644 mondarth-com/content/post/fvtt-mod-dev-local-project-setup/index.md diff --git a/mondarth-com/content/post/fvtt-mod-dev-github-repository-setup/index.md b/mondarth-com/content/post/fvtt-mod-dev-github-repository-setup/index.md new file mode 100644 index 0000000..ffab29c --- /dev/null +++ b/mondarth-com/content/post/fvtt-mod-dev-github-repository-setup/index.md @@ -0,0 +1,18 @@ ++++ +title = "Github Repository Setup" +date = 2024-08-22T09:00:00Z +draft = false +summary="Learning Foundry VTT Module Development from the very start" +categories = ['Technical', 'FoundryVTT', 'Foundry VTT for Module Developers'] +prev = ['/post/lets-build-a-module/'] ++++ + +In the [previous post]({{< ref "/post/lets-build-a-module/" >}}) I proposed we build a couple of Foundry modules. This post starts that process, looking at Github to hold our module code. + +{{< youtube nXZ-fwcygYk >}} + +Although not a detailed lesson on Github, this session covers: + +* Setting up your account to use SSH keys. +* Creating a repository to hold our module. +* Cloning that repository to our local development machine so we can work on the module. diff --git a/mondarth-com/content/post/fvtt-mod-dev-local-project-setup/index.md b/mondarth-com/content/post/fvtt-mod-dev-local-project-setup/index.md new file mode 100644 index 0000000..74417a0 --- /dev/null +++ b/mondarth-com/content/post/fvtt-mod-dev-local-project-setup/index.md @@ -0,0 +1,25 @@ ++++ +title = "Local Project Setup" +date = 2024-08-23T09:00:00Z +draft = false +summary="Learning Foundry VTT Module Development from the very start. In this session: setting up the local project." +categories = ['Technical', 'FoundryVTT', 'Foundry VTT for Module Developers'] +prev = ['/post/fvtt-mod-dev-github-repository-setup/'] ++++ + +Having cloned our Github repository to our local development machine we now set up some basic tooling that will help later as we develop our module. + +{{< youtube 8Qm0XJSWqYU >}} + +In this session we set up: + +* [`npm`](https://www.npmjs.com/), initialising our project. +* [`husky`](https://typicode.github.io/husky/) to marshal our `git` hook scripts. +* [`commitizen`](https://github.com/commitizen/cz-cli) to enforce standard `git` log messages. + +These tools provide some 'guardrails' on our project that, although they may seem onerous now, will pay dividends later by facilitating: + +* The production of consistent a changlog for our release notes (poviding users and other developers with timely and accurate details of what changes occur to our module). +* Management of our release versioning. + +A few minutes of setup now will save hours over the life of our module.