peripatos.free.technology/README.md

54 lines
1.0 KiB
Markdown

# [Peripatos](https://term.m4tt72.com)
A terminal style website
![screenshot](/docs/screenshot.png)
## IMPORTANT
This is a new version of [m4tt72/terminal](https://github.com/m4tt72/terminal), which is built with [Svelte](https://svelte.dev/).
If you are looking for the old version, please check out the [v2 branch](https://github.com/m4tt72/terminal/tree/v2).
The old version is built with [React](https://reactjs.org/), and it is no longer maintained.
Thanks!
## Quick Start
### Using docker (recommended)
```bash
docker run -d --name terminal -p 3000:3000 ghcr.io/m4tt72/terminal
```
### Using npm/yarn
1. Install dependencies:
```bash
yarn install
```
3. Run the server:
```bash
yarn dev
```
## 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!
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=m4tt72/terminal&type=Date)](https://star-history.com/#m4tt72/terminal&Date)