From 573568ee6dde51b4a2eca1045d9cd0caf71822a7 Mon Sep 17 00:00:00 2001 From: niku Date: Thu, 27 Jul 2023 10:44:08 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c2ae743..3cad957 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# twitch-clone - ![](assets/logo.png) +# twitch-clone + A Twitch clone to experiment with various technologies. ![](assets/screenshot.png) @@ -13,6 +13,29 @@ A Twitch clone to experiment with various technologies. - Next.JS for the frontend, React with SSR important for SEO and to speed up the initial load. - Tailwind for styling, eliminating the need to manage stylesheets. +## Dependencies +- [podman](https://github.com/containers/podman) +- [pnpm](https://github.com/pnpm/pnpm) +- [node](https://github.com/nodejs/node) +- [go](https://github.com/golang/go) + +## Usage +Start the necessary infrastructure: +```sh +podman-compose up +``` + +Start the frontend: +```sh +cd client +pnpm i +pnpm run dev +``` + +Start the chat-service: +``` +go run ./cmd/chat-service/main.go +``` ## Disclaimer I am in no way affiliated with Amazon or Twitch.