HashWarlock / terminal

Terminal style website

hashwarlock | Terminal

A terminal style website based on M4TT72

why?

TL;DR: why not? M4TT72 made a cool project and I had to build a custom version for myself :P

Quick Start

Using docker (recommended)

docker run -d --name terminal -p 3000:3000 m4tt72/terminal

If you want to run with custom configuration, make sure you have a copy of config.json then mount in the container:

docker run -d \
  --name terminal \
  -p 3000:3000 \
  -v `pwd`/config.json:/data/config.json \
  m4tt72/terminal

Using npm/yarn

1. Install dependencies:

yarn install

2. Build the project:

yarn build

3. Run the server:

yarn start

Configuration

Here's a sample of the config.json file:

{
  "bioUrl": "https://raw.githubusercontent.com/hashwarlock/hashwarlock/master/README.md",
  "social": {
    "twitter": "hashwarlock",
    "github": "hashwarlock",
    "linkedin": "joshua-waller-33935773"
  },
  "theme": "gruvboxdark" // list of themes available in themes.json
}

Themes

Here's a list of available themes.

Contributing

Please feel free to pull requests or log issues.

Thanks!

Star History