From 370e056a2b481c2281fc10f5823a898fb85d9340 Mon Sep 17 00:00:00 2001 From: Riley Smith Date: Wed, 2 Feb 2022 16:13:08 -0800 Subject: [PATCH] (doc): readme changes --- README.md | 23 +++++++++++++++++++++++ backend/README.md | 1 + frontend/README.md | 40 +--------------------------------------- 3 files changed, 25 insertions(+), 39 deletions(-) create mode 100644 README.md create mode 100644 backend/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5af8eb4 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# watchtogether + +This was a project that I created over 7 days of working while having covid :) + +I probably won't do much with the codebase, but enjoy how I basically figured out how to sync video streams with multiple clients + +## The Stack + +- frontend + + - next js + - websockets + - chakra-ui + - react-player + +- backend + + - go + - gorilla/websockets + +## how 2 deploy? + +you don't diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..18803d0 --- /dev/null +++ b/backend/README.md @@ -0,0 +1 @@ +# backend diff --git a/frontend/README.md b/frontend/README.md index d5d207c..89ce48d 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,39 +1 @@ -# Example app with [chakra-ui](https://github.com/chakra-ui/chakra-ui) and TypeScript - -This example features how to use [chakra-ui](https://github.com/chakra-ui/chakra-ui) as the component library within a Next.js app with TypeScript. - -Next.js and chakra-ui have built-in TypeScript declarations, so we'll get autocompletion for their modules straight away. - -We are connecting the Next.js `_app.js` with `chakra-ui`'s Provider and theme so the pages can have app-wide dark/light mode. We are also creating some components which shows the usage of `chakra-ui`'s style props. - -## Preview - -Preview the example live on [StackBlitz](http://stackblitz.com/): - -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-chakra-ui-typescript) - -## Deploy your own - -Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example): - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-chakra-ui-typescript&project-name=with-chakra-ui-typescript&repository-name=with-chakra-ui-typescript) - -## How to use - -### Using `create-next-app` - -Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example: - -```bash -npx create-next-app --example with-chakra-ui-typescript with-chakra-ui-typescript-app -# or -yarn create next-app --example with-chakra-ui-typescript with-chakra-ui-typescript-app -``` - -Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). - -## Notes - -Chakra has supported Gradients and RTL in `v1.1`. To utilize RTL, [add RTL direction and swap](https://chakra-ui.com/docs/features/rtl-support). - -If you don't have multi-direction app, you should make `` inside `_document.ts`. +# frontend