ItsDrike/itsdrike.com
1
0
Fork 0
mirror of https://github.com/ItsDrike/itsdrike.com.git synced 2024-11-09 21:49:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
ItsDrike 2021-08-26 12:22:11 +00:00 committed by GitHub
parent e97f318101
commit 77c00bd40c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,23 +1,18 @@
# My personal website
[![AGPL](https://img.shields.io/badge/Licensed%20under-AGPL-red.svg?style=flat-square)](./LICENSE)
[![Validation](https://github.com/ItsDrike/portfolio/actions/workflows/validation.yaml/badge.svg)](https://github.com/ItsDrike/portfolio/actions/workflows/validation.yaml)
This is the source code for my personal portfolio, hosted on [my website](http://itsdrike.com)
This is the source code for my personal website, hosted on <https://itsdrike.com>
## Building the website
The website is built using [hugo](https://gohugo.io/), but you will also need `npm`.
`npm` is necessary for the ease of version control it provides for the packages we need. These include things such as:
- [Bootstrap SASS](https://getbootstrap.com/docs/5.0/customize/sass/)
- [Font Awesome (Free)](https://fontawesome.com/).
The website is built using [hugo](https://gohugo.io/), but you will also need `npm`, since it provides easy way to version control the needed packages. These include things such as [Bootstrap SASS](https://getbootstrap.com/docs/5.0/customize/sass/), [Font Awesome (Free)](https://fontawesome.com/) and [JQuery](https://jquery.com/).
All `npm` dependencies are listed in [`package.json`](./package.json) and can be installed simply by running `npm install`.
After all NPM requirements are satisfied, to build the static webpage and hugo is installed, run [`./scripts/build.sh`](./scripts/build.sh),
which will create a `./public` directory, which will contain all static files and can be used as a location for the file server.
After all NPM requirements are satisfied, to build the static webpage and `hugo` is installed, run [`./scripts/build.sh`](./scripts/build.sh),
which will create a `./public` directory. This directory will contain all static files and can be used as a location for the file server.
You can then use any file server of your liking to make the webpage available, if you want to stick to hugo, you can also use
[`scripts/server.sh`](./scripts/server.sh), however using this can be a bit slower than using some other tools.
If using the script, it will start the server directly with hugo on `http://localhost:1313`.
You can then use any file server of your liking to make the webpage available, if you want to stick to hugo, you can use a custom script, that runs the build script automatically and then starts the hugo server for you: [`scripts/server.sh`](./scripts/server.sh). By default, this will use <http://localhost:1313>, but you can pass hugo server arguments just like you would normally, so you can do:
```
$ ./scripts/server.sh --bind 0.0.0.0 --port 80 --baseURL https://itsdrike.com/
```