diff --git a/README.md b/README.md index f6abd46..c1c3dee 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,16 @@ - https://tamagui.dev/docs/guides/next-js - https://nextjs.org/docs -### Setting Up For Development +### Running With Docker +1) Open your terminal and navigate to the root of the git repository. +2) Make sure that docker and docker compose are installed. +3) Run `docker-compose --env-file ./docker.env up` which will start up OwnCast, AppWrite, and the UI. + +- OwnCast http://localhost:8080/ +- AppWrite http://localhost:80/ +- UI http://localhost:3000 + +### Running Without Docker 1) Open your terminal and navigate to the root folder of the git repository. 2) Run the command `npm update`. 3) Once the depedencies are pulled and installed you can run the command `npm run dev` to run the application in development mode.