Skip to content

Commit

Permalink
Merge pull request #40 from AngleProtocol/doc/hosting
Browse files Browse the repository at this point in the history
doc: add hosting readme
  • Loading branch information
Picodes authored Dec 4, 2024
2 parents a229492 + 1fef689 commit 3f4daeb
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,25 @@ bun dev

## Deployment

### Host with Docker (recommended)

First you will need to build and push the image to a docker registry

1. Setup a Docker registry if you don't have one (on [DockerHub](https://hub.docker.com/) for example)
2. Go to the root of this repository
3. Build the docker container: `docker build --tag <REGISTRY_URL>/merkl-lite:latest .`
4. Push it to your registry: `docker push <REGISTRY_URL>/merkl-lite:latest`

Now you will need to deploy the container, here are a few hosting solutions:

- [Cloud Run](https://cloud.google.com/run) on Google Cloud
- [ECS Fargate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) on AWS
- Docker-compose on any VM

Then you only need to set the PORT environment variable and it ill work! We recommend setting the PORt to 5173 (it is exposed in the Dockerfile) but feel free to change it.

### Host it yourself

First, build your app for production:

```sh
Expand Down

0 comments on commit 3f4daeb

Please sign in to comment.