Skip to content

Commit

Permalink
chore(readme): create selfhosting guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Luna committed Feb 18, 2024
1 parent 3d0f47a commit 5492c5d
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# web-expl

Explore the internet in 3-dimensional space.
Built with NextJS, TailwindCSS and ThreeJS.

## Demo
You can try out the live demo [here](https://web-expl.qwq.sh).

![Visualizer](./assets/screenshot.png)

## Deployment

You can selfhost `web-expl` using Docker.
To deploy the scraper, run:

```bash
docker run -p <OUTGOING_PORT>:3000 --restart=always --name web-expl ghcr.io/angelsflyinhell/web-expl
```

## Installation

Install `web-expl` with npm:

```bash
gh repo clone angelsflyinhell/web-expl
cd web-expl

npm install

npm run dev
```

0 comments on commit 5492c5d

Please sign in to comment.