owncast/web
2021-08-17 18:41:09 -07:00
..
.github Admin support for managing users (#245) 2021-07-19 22:02:02 -07:00
.vscode Start codec selection in admin 2021-04-13 13:54:57 -07:00
components Dedupe name list 2021-08-17 17:38:10 -07:00
docs - add <Col>s to areas with <Row>s for consitency 2021-02-15 21:22:17 -08:00
pages fix chat message pagination (#278) 2021-08-14 12:22:05 -07:00
public
styles fix black-on-black text (#270) 2021-08-10 12:13:11 -07:00
types Admin support for managing users (#245) 2021-07-19 22:02:02 -07:00
utils change admin directory toggle text (#279) 2021-08-15 14:25:15 -07:00
.editorconfig
.env.development
.env.production Support API calls without auth and without cors 2020-11-07 16:44:11 -08:00
.eslintignore Configure eslint action 2021-02-06 19:13:04 -08:00
.eslintrc.js Update Next to 11.0.1 (including lint & import fixes) (#248) 2021-07-09 11:42:01 -07:00
.gitignore
.prettierignore
.prettierrc some prettifying 2021-01-31 01:38:20 -08:00
favicon.ico
LICENSE
next-env.d.ts Package updates updated these files 2021-08-12 23:46:57 -07:00
next.config.js Change export paths 2020-11-09 12:06:28 -08:00
package-lock.json Add lodash 2021-08-17 18:41:09 -07:00
package.json Add lodash 2021-08-17 18:41:09 -07:00
README.md Add some additional details in readme 2021-05-06 14:48:10 -07:00
tsconfig.json Use unkonwn fallback string for values not supplied by remote encoder. 2020-12-02 17:51:33 -08:00

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!