Skip to content

Commit

Permalink
update(docs): profile page with md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rooyca committed Jun 6, 2024
1 parent 7858d75 commit 5f2d903
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# 🌳 GHTree

Web app similar to LinkTree using information from GitHub profile.
> From [simplesite template](https://github.com/tataraba/simplesite)
Web app similar to LinkTree using information from GitHub.

![ShowCase](showcase.png)
![ShowCase](showcase_2.png)

## 🧪 Try it out

> It may take a few seconds to load the first time.
### [https://ghtree.fly.dev/](https://ghtree.fly.dev/)
### https://ghtree.onrender.com/v2/rooyca

## 🌟 Don't hesitate to open a pull request with [your own profile](app/data/rooyca.md). 🌟

## 🚀 Deploy

You can run your own instance locally or deploy it to a serverless platform like [Fly.io](https://fly.io/).
You can run your own instance locally or deploy it to a serverless platform like [Fly.io](https://fly.io/) or [Render](https://render.com/).

### -> Locally

Expand Down Expand Up @@ -43,7 +44,7 @@ Although I recommend using the [alpine version](Dockerfile), since it is the sma

| Dockerfile | Size |
| --- | --- |
| [Dockerfile (alpine)](Dockerfile) | 163 MB |
| [Dockerfile (alpine)](Dockerfile) | 167 MB |
| [Dockerfile.slim](Dockerfile.slim) | 562 MB |
| [Dockerfile.full](Dockerfile.full) | +1 GB |

Expand All @@ -57,7 +58,7 @@ python -m uvicorn app.main:app --reload

### -> Serverless

You can deploy the app to any serverless platform that supports Python apps, like [Fly](https://fly.io/) or any other.
You can deploy the app to any serverless platform that supports Python apps, like [Fly](https://fly.io/), [Render](https://render.com/) or any other.

#### 🦋 Fly.io

Expand All @@ -66,6 +67,16 @@ fly launch
fly deploy
```

#### 🚀 Render

Run it with Docker. Use the following image:

```sh
ghcr.io/rooyca/ghtree:master
```

That's it! 🎉

## 🛠️ Build with

- [FastAPI](https://fastapi.tiangolo.com/)
Expand Down
Binary file added showcase_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5f2d903

Please sign in to comment.