forked from msb-public/LiveTerm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 lines
3.1 KiB
118 lines
3.1 KiB
# [LiveTerm - Make Terminal styled websites in minutes!](https://cveinnt.com)
|
|
|
|
Highly customizable, easy-to-use, and minimal terminal styled website template, written in Next.js.
|
|
|
|
# Table of Contents:
|
|
|
|
- [LiveTerm - Make Terminal styled websites in minutes!](#liveterm---make-terminal-styled-websites-in-minutes)
|
|
- [Table of Contents:](#table-of-contents)
|
|
- [Showcase](#showcase)
|
|
- [Quick Start](#quick-start)
|
|
- [Configuration](#configuration)
|
|
- [Basic Configuration](#basic-configuration)
|
|
- [Favicons](#favicons)
|
|
- [Banner](#banner)
|
|
- [Advanced Configuration](#advanced-configuration)
|
|
- [Deploy on Vercel](#deploy-on-vercel)
|
|
- [Credit](#credit)
|
|
|
|
## Showcase
|
|
|
|
<p align="center">
|
|
<img src="./demo/demo.png" width="800"><br>
|
|
<strong>Default LiveTerm</strong>
|
|
</p>
|
|
|
|
Live version [here](https://cveinnt.com)
|
|
|
|
<p align="center">
|
|
<img src="./demo/cveinnt.png" width="800"><br>
|
|
<strong>my personal website</strong>
|
|
</p>
|
|
|
|
Live version [here](https://cveinnt.com)
|
|
|
|
## Quick Start
|
|
|
|
First, clone this repository:
|
|
|
|
```bash
|
|
git clone https://github.com/Cveinnt/LiveTerm.git
|
|
```
|
|
|
|
Then, install dependencies:
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
Now you can start development!
|
|
|
|
```bash
|
|
yarn dev
|
|
```
|
|
|
|
Or, you can build the project:
|
|
|
|
```bash
|
|
yarn build && yarn start
|
|
```
|
|
|
|
## Configuration
|
|
|
|
### Basic Configuration
|
|
|
|
Most of the configuration is done through the `config.json` file.
|
|
|
|
```javascript
|
|
{
|
|
"readmeUrl": //create a Github README and link it here!
|
|
"title": //title of the website
|
|
"name": //returned by the command of the same name
|
|
"social": {
|
|
"github": // your handle
|
|
"linkedin": // your handle
|
|
},
|
|
"email": // your email
|
|
"ps1_hostname": //hostname in prompt
|
|
"ps1_username": "guest", // username in prompt
|
|
"non_terminal_url": "W",
|
|
"colors": {
|
|
... // you can use existing templates in themes.json or use your own!
|
|
}
|
|
}
|
|
```
|
|
|
|
Feel free to change it as you see fit!
|
|
|
|
You can find several pre-configured themes in `themes.json`, and you can replace the colors in `config.json` with the theme color you like! The themes are based on the themes on [this website](https://glitchbone.github.io/vscode-base16-term/#/).
|
|
|
|
<p align="center">
|
|
<img src="./demo/themes.png" width="800"><br>
|
|
<strong>different LiveTerm themes</strong>
|
|
</p>
|
|
|
|
Just replace `"light"` or `"dark"` in the `"color"` part of the config file!
|
|
|
|
### Favicons
|
|
|
|
Favicons are located in `public/`, along with other files you may want to upload. I used this [website](https://www.favicon-generator.org/) to generate favicons.
|
|
|
|
### Banner
|
|
|
|
You may also want to change the output of `banner` command. To do that, simply paste your generated banner in `src/utils/bin/utils.ts`. I used this [website](https://manytools.org/hacker-tools/ascii-banner/) to generate my banner.
|
|
|
|
### Advanced Configuration
|
|
|
|
If you want to further customize your page, feel free to change the source code to your preference!
|
|
|
|
## Deploy on Vercel
|
|
|
|
The easiest way to deploy a Next.js app is to use the [Vercel Platform](https://vercel.com/) from the creators of Next.js.
|
|
|
|
Check out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
|
|
|
## Credit
|
|
|
|
Based on M4TT72's awesome [Terminal](https://github.com/m4tt72/terminal).
|