owncast/web
2020-10-22 17:16:28 -07:00
..
pages some cleanup 2020-10-22 17:16:28 -07:00
public Initial commit from Create Next App 2020-09-30 15:13:06 -07:00
styles some cleanup 2020-10-22 17:16:28 -07: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
.eslintrc.js eslint rule updates for typescript 2020-10-10 18:48:29 -07:00
.gitignore add victory graphing lib 2020-10-10 17:52:13 -07:00
.prettierignore Add linting and code formatting 2020-09-30 18:47:18 -07:00
.prettierrc Add linting and code formatting 2020-09-30 18:47:18 -07: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 Build should expect /admin to be the root 2020-09-30 17:12:22 -07:00
package-lock.json initial line chart setup with d3 help 2020-10-11 21:46:56 -07:00
package.json a bit of refactor, use context for overall broacast status; move files around for routing 2020-10-22 16:18:18 -07:00
README.md initial files 2020-10-03 20:59:25 -07:00
tsconfig.json Bootstrap the admin project 2020-09-30 15:13:06 -07:00
yarn.lock initial line chart setup with d3 help 2020-10-11 21:46:56 -07: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!