Skip to content

Latest commit

 

History

History
82 lines (63 loc) · 3.41 KB

README.md

File metadata and controls

82 lines (63 loc) · 3.41 KB
Raw

Home Page

Very first home page to teach myself the basics of how to use HTML, CSS, JavaScript, and Node.js. Before this, I had no knowledge of any web development.

Obvious heavy visual inspiration from alanrey6. Many tweaks, comments, and changes were made just about everywhere to theirs other than the visuals. I basically wanted to improve his version and learn how to make it myself, while customizing it to my needs and adding a way to deploy it using Express.js through docker. This repository will essentially be my notes on how it works and to run it.

Manual Setup

Node.js is needed to run the HTTP server. I tested it with the WSL2 version.

To enable weather functionality, a .env file needs to be created in the root directory with an OpenWeatherMap API key along with a location. One can paste the necessary values into the .env.sample file then remove .sample from the filename.

Web links, located in /public/js/config.js, can be customized to whatever one desires. See below for config details.

Install the packages in the environment with:

$ npm install

To start the web server:

$ node app.js

Docker Setup

The .env file and web links should be setup in the same manner as the manual setup. Then, the docker image can be built using:

$ docker build . -t marcus/homepage

To run the container:

$ docker run -p 8080:8080 -d --name homepage marcus/homepage

Docker-Compose Setup

An example docker-compose file is also provided to use instead of the docker CLI. To build and run:

$ docker-compose build
$ docker-compose up -d

Web Link Config

Each entry in /public/js/config.js has two attributes: the column name and a list of web links.

{
    name: "Admin",
    links: [
        {
            href: "",
            target: "_blank",
            content: "Portainer",
            icon: "https://i.imgur.com/729Hh3P.png"
        },
        {
            href: "",
            target: "_blank",
            content: "Pi-hole",
            icon: "https://pi-hole.github.io/graphics/Vortex/Vortex_with_Wordmark.svg"
        },
    ]
}
  • href is the web address to link to.
  • target specifies where to open the link.
  • content is the displayed text.
  • icon is the local or remote icon image location.

Other Links to Read