Here is how to setup the project locally to contribute:
- Clone the repository:
$ git clone git@github.com:gdarchen/gdarchen.github.io.git
- Install the dependencies using
yarn
as follows:$ yarn install
This command not only install both the
dependencies
anddevDependencies
, but also set up the Git hooks.Depending on your version of
yarn
, it might require a change in thepackage.json
file, in thescripts
section:yarn@^1
: use the"postinstall": "husky install"
scriptyarn@^2
: use the"prepare": "husky install"
script
We use two Git hooks:
- one to ensure to run
prettier
on each staged file - one to run
commitlint
so as to ensure commit follow the conventional commit format
- Run the application locally:
$ yarn start
The code is hosted thanks to GitHub Pages.
To deploy a new version, run the following command:
$ yarn deploy