An open API service indexing awesome lists of open source software.

https://github.com/miguelgargallo/terminal

This is a modded version forked from 👇
https://github.com/miguelgargallo/terminal

next react temrinal web

Last synced: 3 months ago
JSON representation

This is a modded version forked from 👇

Awesome Lists containing this project

README

          

# [miguelgargallo | Terminal](https://superdata.dev)

A terminal style website

![image](/docs/screenshot.png)

## 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)

```bash
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:

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

### Using npm/yarn

1. Install dependencies:

```bash
yarn install
```

2. Build the project:

```bash
yarn build
```

3. Run the server:

```bash
yarn start
```

## Configuration

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

```json
{
"bioUrl": "https://raw.githubusercontent.com/miguelgargallo/miguelgargallo/master/README.md",
"social": {
"instagram": "miguelgargallo.es",
"github": "miguelgargallo",
"linkedin": "miguelgargallo"
},
"theme": "hyper" // list of themes available in themes.json
}
```

## Themes

![themes](/docs/screenshot.gif)

[Here's](/docs/themes) a list of available themes.

## Contributing

Please feel free to pull requests or log issues.

Thanks!