Repository of linkkijkl.fi.
First:
- Install git and Git Large File Storage
- Clone this repository, i.e.
git clone https://github.com/linkkijkl/linkki-web
After this there are a few options:
-
Use Devcontainers (best option for Windows)
The Devcontainer configured for this project has all tools required for developing to it installed for you. Devcontainers are available for many IDEs but this guide focues on using Visual Studio Code.
- Install Docker, VSCode and Devcontainers VSCode plugin
- Open this repository in VSCode. A popup should open asking if you want to reopen the project in a container. Do that.
- When the container is running, open a terminal in VSCode (
Ctrl+Shift+P, search forcreate new terminal) and runhugo server.
-
Use local development tools (in Unix compatible environments, like Linux or MacOS)
Then in project root run
yarnto pull js and css dependenciesnpx pagefind --site publicto build search indexeshugo serverand you should be good to go 🎉
-
Use Docker compose
- Install Docker
- Run
docker compose up --build - Open localhost:8080
- When you are finished developing run
docker compose down
- Hugo server watches for changes in code, and they should automatically show up in browser when made. However, sometimes when editing css and js, you should hit
Ctrl+Shift+Rin browser to get them showing up. - Devcontainers can stop allowing network traffic to go trough fully. Git inside will fail to reach remote, your browser won't be able to load pages from
hugo servercorrectly, etc. Rebuild container to fix these weird issues. I've noticed this tends to happen when browser tab has been left open with development site whenhugo serverinside the container is no longer running.
Building and Running With Docker
This is how the site is deployed in production.
docker build --pull -t linkki-web .
docker run -p 127.0.0.1:8080:8080 linkki-webMake a pull request with your changes so we can get them online 🙂
Make a new issue detailing the problem.
Take a look at open issues. From there you should find something to do.
Try running yarn, and make sure you have the extended edition version 0.164.0 of Hugo installed.
If the error ends with error calling imageConfig: image: unknown format run git-lfs install followed by git-lfs pull.
Yes! If you make (a) useful contribution(s) to this repo, you may redeem a free Website Task Force overall patch from a board member in Kattila.