owncast-admin

owncast-admin copied to clipboard

Future of the Admin Project

This repository is no longer active an is archived

TLDR: Any admin changes should be made in the webv2 branch in owncast/owncast and not here.

The "admin" project has been merged into the parent owncast/owncast respository to become te new frontend of Owncast. The admin will stay the same, but a new frontend to Owncast will get built next to it, using the same technologies.

See the Web UI v2 project for more details.

This web migration and rebuild is in progress via the webv2 branch in owncast/owncast and you can follow along wiht the tasks in the web project.

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/docs/api/
• https://owncast.online/api/latest/

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:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

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