owncast/web
2021-05-31 10:35:46 -07:00
..
.github Remove checkout ref 2021-05-24 16:19:33 -07:00
.vscode Start codec selection in admin 2021-04-13 13:54:57 -07:00
components Prettified Code! 2021-05-23 06:28:21 +00:00
docs - add <Col>s to areas with <Row>s for consitency 2021-02-15 21:22:17 -08:00
pages rework stream info box in offline notice to conform more with the overall design (#196) 2021-05-27 15:58:31 -07:00
public
styles rework stream info box in offline notice to conform more with the overall design (#196) 2021-05-27 15:58:31 -07:00
types Start codec selection in admin 2021-04-13 13:54:57 -07:00
utils Prettified Code! 2021-05-23 06:28:21 +00:00
.editorconfig
.env.development
.env.production
.eslintignore
.eslintrc.js add jsx-no-target-blank to eslint config 2021-03-27 18:03:43 -07:00
.gitignore
.prettierignore
.prettierrc
favicon.ico
LICENSE
next-env.d.ts
next.config.js
package-lock.json Bump @typescript-eslint/eslint-plugin from 4.25.0 to 4.26.0 (#201) 2021-05-31 10:35:46 -07:00
package.json Bump @typescript-eslint/eslint-plugin from 4.25.0 to 4.26.0 (#201) 2021-05-31 10:35:46 -07:00
README.md Add some additional details in readme 2021-05-06 14:48:10 -07:00
tsconfig.json

This is a Next.js project with TypeScript, Sass styling, using Ant Design UI components.

Getting Started

First, run the development server:

npm run dev
# or
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 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.

Add new pages by adding files to the pages directory and routes will be available for this new page component.

Since this project hits API endpoints you should make requests in componentDidMount, and not in getStaticProps, since they're not static and we don't want to fetch them at build time, but instead at runtime.

A list of API end points can be found here: https://owncast.online/api/development/

Auth-ing for APIs

Auth: HTTP Basic username: admin pw: [your streamkey]

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!