README.md

M4TT72 | Terminal

A terminal style website

why?

TL;DR: why not?

I'm a Linux enthusiast, and I tried creating something that will allow 'normal' people to have a glimpse at my world.

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/m4tt72/m4tt72/master/README.md",
  "social": {
    "instagram": "m4tt72",
    "github": "m4tt72",
    "linkedin": "yassinefathi"
  },
  "colors": {
    "light": {
      "background": "#FBF1C9",
      "foreground": "#3C3836",
      "yellow": "#D79921",
      "green": "#98971A",
      "gray": "#7C6F64",
      "blue": "#458588"
    },
    "dark": {
      "background": "#262626",
      "foreground": "#EBDBB2",
      "yellow": "#D79921",
      "green": "#98971A",
      "gray": "#A89984",
      "blue": "#458588"
    }
  }
}

Feel free to change it as you see fit

Contributing

Please feel free to pull requests or log issues.

Thanks!