Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.21 KB

README.md

File metadata and controls

66 lines (45 loc) · 1.21 KB
Raw

Marj4n | Terminal

A portfolio but in a terminal.

Quick Start

Clone the repo

  1. Open your terminal and clone the repo:
git clone https://github.com/Marj4n/terminal-portfolio.git
  1. Go to the project directory and install dependencies:
cd terminal-portfolio

# using yarn
yarn install

# using npm
npm install
  1. Run the project:
# using yarn
yarn start

# using npm
npm start

Configuration

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

{
  "social": {
    "instagram": "__kevnnn_",
    "github": "Marj4n",
    "linkedin": "kevin-yardan-fauzan-73baaa21b",
    "twitter": "Marj4nn",
    "spotify": "0c4ostaav8xjbk4i5chtmin7e"
  },
  "theme": "3024Night",
  "border": false
}

Visitor Statistics

Enter your firebase project configuration in the .env for see visitor statistics.

Themes

Run theme ls to see all available themes and theme set <theme> to set the theme. Or you can edit the themes for your own needs in the themes.json file.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.