owncast

History

gingervitis e7e89556e7 apply config form flow to edit content page		2021-01-24 13:05:43 -08:00
..
.github/workflows	Verify the admin web app builds	2020-11-13 10:09:20 -08:00
pages	apply config form flow to edit content page	2021-01-24 13:05:43 -08:00
public
styles	apply config form flow to edit content page	2021-01-24 13:05:43 -08:00
types	apply config form flow to edit content page	2021-01-24 13:05:43 -08:00
utils	apply config form flow to edit content page	2021-01-24 13:05:43 -08:00
.editorconfig
.env.development
.env.production	Support API calls without auth and without cors	2020-11-07 16:44:11 -08:00
.eslintrc.js	eslint rule updates for typescript	2020-10-10 18:48:29 -07:00
.gitignore	It builds	2020-11-01 00:46:20 -07:00
.prettierignore
.prettierrc
favicon.ico	a bit of refactor, use context for overall broacast status; move files around for routing	2020-10-22 16:18:18 -07:00
LICENSE
next-env.d.ts
next.config.js	Change export paths	2020-11-09 12:06:28 -08:00
package-lock.json	First pass at page content editor	2021-01-24 13:05:43 -08:00
package.json	First pass at page content editor	2021-01-24 13:05:43 -08:00
README.md
tsconfig.json	Use unkonwn fallback string for values not supplied by remote encoder.	2020-12-02 17:51:33 -08:00

README.md

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

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://github.com/owncast/owncast/blob/master/router/router.go

Auth-ing for APIs

username: admin pw: [your stramkey]

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!