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

Add install instructions to README

Browse source
This commit is contained in:
ItsDrike 2021-08-25 09:47:29 +02:00
parent 0b054af849
commit 7cf588fca0
No known key found for this signature in database
GPG key ID: B5F6B41F708C3ADD
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -5,4 +5,12 @@
This is the source code for my personal portfolio, hosted on [my website](http://itsdrike.com)
It is built using [huge](https://gohugo.io/).
## Building the website
The website is built using [hugo](https://gohugo.io/), but you will also need `npm` for [Bootstrap SASS](https://getbootstrap.com/docs/5.0/customize/sass/).
The `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, 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 also use [`./scripts/server.sh`](./scripts/server.sh), which
will start the server directly with hugo. By default, this will use `http://localhost:1313`.