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.5 KiB
118 lines
3.5 KiB
# [💻 LiveTerm - build terminal styled websites in minutes!](https://liveterm.vercel.app)
|
|
|
|
Highly customizable, easy-to-use, and minimal terminal styled website template, powered by Next.js.
|
|
|
|
Building a simple website with LiveTerm only takes **minutes**, and you only need to work with **one** file: `config.json`. After you cloned this repository, simply run `yarn install && yarn dev` and start editing `config.json` to build your website!
|
|
|
|
LiveTerm can be used to build a variety of websites:
|
|
|
|
- [personal website](https://cveinnt.com)
|
|
- [browser startpage](https://livetermstart.vercel.app/)
|
|
- [project page](https://liveterm.vercel.app/)
|
|
- or maybe just a cool browser music player...be creative!
|
|
|
|
Feel free to play with the web demo above!
|
|
|
|
## 📸 Showcase
|
|
|
|
<p align="center">
|
|
<img src="./demo/demo.png" width="800"><br>
|
|
<strong>default LiveTerm</strong>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="./demo/cveinnt.png" width="800"><br>
|
|
<strong>my personal website</strong>
|
|
</p>
|
|
|
|
## 🚀 Ship your LiveTerm site in less than 5 minutes
|
|
|
|
First, clone this repository:
|
|
|
|
```bash
|
|
git clone https://github.com/Cveinnt/LiveTerm.git
|
|
```
|
|
|
|
Then, install dependencies:
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
Now you can start developing!
|
|
|
|
```bash
|
|
yarn dev
|
|
```
|
|
|
|
Start editing `config.json` and try saving and see the updated changes!
|
|
|
|
## 📄 Configuration
|
|
|
|
### Basic Configuration
|
|
|
|
90% of LiveTerm's configurations are done through the `config.json` file.
|
|
|
|
```javascript
|
|
{
|
|
"readmeUrl": // create a Github README and link it here!
|
|
"title": // title of the website
|
|
"name": // your name, included in 'about' command
|
|
"ascii": // ascii art to display
|
|
"social": {
|
|
"github": // your handle
|
|
"linkedin": // your handle
|
|
},
|
|
"email": // your email
|
|
"ps1_hostname": "liveterm" // hostname in prompt
|
|
"ps1_username": "visitor", // username in prompt
|
|
"resume_url": "../resume.pdf", // path to your resume
|
|
"non_terminal_url": "W",
|
|
"colors": {
|
|
"light": {
|
|
...
|
|
},
|
|
"dark": {
|
|
... // you can use existing templates in themes.json or use your own!
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Feel free to change it as you see fit!
|
|
|
|
### Themes
|
|
|
|
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>
|
|
|
|
For a better preview of the themes, checkout the images in the `demo` folder.
|
|
|
|
### Favicons
|
|
|
|
Favicons are located in `public/`, along with the other files you may want to upload to your website. I used this [website](https://www.favicon-generator.org/) to generate favicons.
|
|
|
|
### Banner
|
|
|
|
You may also want to change the output of the `banner` command. To do that, simply paste your generated banner in `src/utils/bin/commands.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 liking!
|
|
|
|
## 🌐 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.
|
|
|
|
You can install `vercel` cli and follow the instruction [here](https://vercel.com/docs/concepts/deployments/overview).
|
|
|
|
You can also connect your github account to vercel and have vercel automatically deploy the github repository for you.
|
|
|
|
## Credit
|
|
|
|
Based on M4TT72's awesome [Terminal](https://github.com/m4tt72/terminal).
|