From eb1c03c15fb8717e768c97e056fb0105f034b220 Mon Sep 17 00:00:00 2001 From: Gabe Kangas Date: Thu, 6 May 2021 14:48:10 -0700 Subject: [PATCH] Add some additional details in readme --- web/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/web/README.md b/web/README.md index 51b274fe9..06545497a 100644 --- a/web/README.md +++ b/web/README.md @@ -2,7 +2,7 @@ This is a [Next.js](https://nextjs.org/) project with [TypeScript](https://www.t ## Getting Started -First, run the development server: +**First**, run the development server: ```bash npm run dev @@ -10,6 +10,9 @@ npm run dev yarn dev ``` +**Second**, make sure you're running an instance of Owncast on localhost:8080, as your copy of the admin will look to use that as the API. + + In production this Admin instance would ideally live on the domain as your Owncast instance, for example: `myowncast-site.com/admin`. So open [http://localhost:3000/admin](http://localhost:3000/admin) with your browser to see the result. You can start editing a page by modifying `pages/something.js`. The page auto-updates as you edit the file. @@ -20,11 +23,12 @@ Since this project hits API endpoints you should make requests in [`componentDid A list of API end points can be found here: -https://github.com/owncast/owncast/blob/master/router/router.go +https://owncast.online/api/development/ ### Auth-ing for APIs +Auth: HTTP Basic username: admin -pw: [your stramkey] +pw: [your streamkey] ## Learn More