https://github.com/patrickfav/website-favre
The source for my private website powered by hugo a static code generators and typescript/node based CLI to fetch my content from various sites..
https://github.com/patrickfav/website-favre
congo hugo nodejs portfolio-website static-site-generator tailwindcss typescript website-performance
Last synced: about 1 year ago
JSON representation
The source for my private website powered by hugo a static code generators and typescript/node based CLI to fetch my content from various sites..
- Host: GitHub
- URL: https://github.com/patrickfav/website-favre
- Owner: patrickfav
- Created: 2018-05-31T16:06:42.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T13:09:07.000Z (about 1 year ago)
- Last Synced: 2025-03-23T20:51:18.405Z (about 1 year ago)
- Topics: congo, hugo, nodejs, portfolio-website, static-site-generator, tailwindcss, typescript, website-performance
- Language: TypeScript
- Homepage: https://favr.dev
- Size: 40.9 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Static Site Gen Repo for my Personal Website
A simple website with a list of all of my open source projects and articles I wrote. Can be found on [favr.dev](https://favr.dev). Uses [Hugo](https://gohugo.io/) as static site generator.
[](https://github.com/patrickfav/website-favre/actions)
[](https://github.com/patrickfav/website-favre/actions)
[](https://sonarcloud.io/summary/new_code?id=patrickfav_website-favre)
[](https://sonarcloud.io/summary/new_code?id=patrickfav_website-favre)
[](https://sonarcloud.io/summary/new_code?id=patrickfav_website-favre)
## Prepare
### Install Hugo
* Windows `choco install hugo-extended`
* Mac `brew install hugo`
### Install Node
Currently, this project uses [Node 18.17.0 (lts)](https://nodejs.org/es/blog/release/v18.17.0). It is recommended to use
a node version manager like [nvm](https://github.com/nvm-sh/nvm), then you can just run
```bash
nvm install && nvm use
```
in the project root dir to install and use the correct version.
### Cloning Project with Submodule
This project uses a git submodule for including the theme. To correctly clone it you need to do
```bash
git clone https://github.com/patrickfav/website-favre.git
git submodule init
git submodule update
```
## Build & Run
### Set secrets
For the downloader to work with all features one must set 2 environmental variables
````bash
GITHUB_TOKEN=... # a GitHub Personal Access Token - https://docs.github.com/de/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
FIREBASE_SERVICE_ACCOUNT_JSON= {...} # a Firebase service account json file - https://firebase.google.com/support/guides/service-accounts
````
where the second, the Firebase service account json, is optional and not providing it will disable the stats persisting feature.
### Prepare Content Sync
Install and link everything and build the js files from typescript with
```bash
cd content-downloader
npm run package
```
then either run it with
```bash
hugo-content-downloader
```
or use the shortcut that automatically rebuilds the sources
```bash
npm run exec
```
which will populate the directories `content/opensource` and `content/articles`.
### Linting
This project uses [eslint](https://eslint.org/) to validate the code:
```bash
cd content-downloader
npm run lint
```
### Using the build & run Docker Image
A docker image that builds everything, updates the content and then can be used to locally serve the website with nginx can be created by doing:
```bash
docker build --no-cache --progress=plain -t websitefavre:latest .
docker run -p 8080:80 websitefavre:latest
```
and then you can access the page with `http://localhost:8080`
# License
Proprietary: Patrick Favre 2023