owncast/web
2021-02-05 17:24:19 -08:00
..
.github/workflows Force build on any branch 2021-02-02 11:02:38 -08:00
pages Add some context and instructions around latency levels 2021-02-05 17:24:19 -08:00
public Initial commit from Create Next App 2020-09-30 15:13:06 -07:00
styles prettify some files 2021-02-04 09:19:16 -08:00
types revise Storage forms, and add basic validation to it; misc field cleanup 2021-01-31 23:40:39 -08:00
utils Return the error message instead of the http status code 2021-02-05 14:23:18 -08:00
.editorconfig Bootstrap the admin project 2020-09-30 15:13:06 -07:00
.env.development blah 2020-10-07 23:09:42 -07:00
.env.production Support API calls without auth and without cors 2020-11-07 16:44:11 -08:00
.eslintrc.js some prettifying 2021-01-31 01:38:20 -08:00
.gitignore It builds 2020-11-01 00:46:20 -07:00
.prettierignore Add linting and code formatting 2020-09-30 18:47:18 -07:00
.prettierrc some prettifying 2021-01-31 01:38:20 -08:00
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 Initial commit 2020-09-30 14:47:14 -07:00
next-env.d.ts Bootstrap the admin project 2020-09-30 15:13:06 -07:00
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 initial files 2020-10-03 20:59:25 -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

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:

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