LogalDeveloper/owncast
LogalDeveloper/owncast
0
Fork 0
Code

Add some additional details in readme

Browse Source
This commit is contained in:
Gabe Kangas 2021-05-06 14:48:10 -07:00 committed by GitHub
parent 9150fba317
commit eb1c03c15f
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
web/README.md
View File

@ -2,7 +2,7 @@ This is a [Next.js](https://nextjs.org/) project with [TypeScript](https://www.t
## Getting Started ## Getting Started
First, run the development server: **First**, run the development server:
```bash ```bash
npm run dev npm run dev
@ -10,6 +10,9 @@ npm run dev
yarn 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. 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. 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: 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-ing for APIs
Auth: HTTP Basic
username: admin username: admin
pw: [your stramkey] pw: [your streamkey]
## Learn More ## Learn More