owncast/web
2023-01-30 15:33:16 -08:00
..
.storybook More fixes to disabling story snapshot UI tests 2023-01-30 15:23:27 -08:00
.vscode Add current user object that holds user session values instead of standalone getters. Closes #2050 2022-10-10 16:40:13 -07:00
assets/images Update image paths in story 2023-01-12 15:06:01 -08:00
components Set a diff threshold to header story 2023-01-30 15:33:16 -08:00
docs improve stream testing script (#2549) 2023-01-10 18:50:32 -08:00
interfaces Support color customization from the admin (#2338) 2022-11-12 20:26:55 -08:00
pages Add aria-title attribute to video player. For #1826 2023-01-23 19:28:32 -08:00
public Tweak admin styles to be using less custom overrides 2023-01-13 14:20:46 -08:00
services Support customSocketOverride value for websocket. Closes #2225 2022-10-18 20:43:23 -07:00
stories Increase diff threshold for UI tests: #2292 #2630 #2629 2023-01-30 14:46:34 -08:00
style-definitions Change another user display color to meet a11y requirements 2023-01-29 14:13:12 -08:00
styles Prettified Code! 2023-01-29 22:26:17 +00:00
types Allow adding custom javascript to the page. Closes #2604 2023-01-18 22:38:24 -08:00
utils Allow adding custom javascript to the page. Closes #2604 2023-01-18 22:38:24 -08: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
.eslintignore Configure eslint action 2021-02-06 19:13:04 -08:00
.eslintrc.js chore(deps): update dependency eslint-plugin-react to v7.32.0 (webv2) (#2580) 2023-01-16 12:38:06 -08:00
.gitignore Add support for less variables and using a custom theme 2022-04-25 15:52:38 -07:00
.prettierignore Add linting and code formatting 2020-09-30 18:47:18 -07:00
.prettierrc Fix web project build errors 2022-05-11 23:31:31 -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 Admin social features (#408) 2022-01-12 13:52:37 -08:00
next.config.js Only create source maps when setting SOURCE_MAPS 2023-01-30 09:40:29 -08:00
package-lock.json chore(deps): lock file maintenance 2023-01-30 17:27:31 +00:00
package.json fix(deps): update dependency react-virtuoso to v4.0.6 2023-01-29 18:31:05 +00:00
postcss.config.js First pass at component library 2022-04-25 15:52:38 -07:00
README.md add shellcheck to CI (#2478) 2022-12-25 19:17:13 -08:00
renovate.json Fix web project build errors 2022-05-11 23:31:31 -07:00
tsconfig.json Fix web project build errors 2022-05-11 23:31:31 -07:00

Owncast Web Frontend

The Owncast web frontend is a Next.js project with React components, TypeScript, Sass styling, using Ant Design UI components.

Getting Started

First, install the dependencies.

npm install --include=dev

Components and Styles

You can start the Storybook UI for exploring, testing, and developing components by running:

npm run storybook

This allows for components to be made available without the need of the server to be running and changes to be made in isolation.

Contribute

  1. Find a component that hasn't yet been worked on by looking through the UIv2 milestone and the sidebar of components in storybook.
  2. See if you can have an example of this functionality in action via the Owncast Demo Server or Owncast Nightly Build so you know how it's supposed to work if it's interactive.
  3. Visit the Docs tab to read any specific documentation that may have been written about how this component works.
  4. Go to the Canvas tab of the component you selected and see if there's a Design attached to it.
  5. If there is a design, then that's a starting point you can use to start building out the component.
  6. If there isn't, then visit the Owncast Demo Server, the Owncast Nightly Build, or the proposed v2 design for some ways to start.
  7. If no design exists, then you can ask around the Owncast chat for help, or come up with your own ideas!
  8. No designs are stuck in stone, and we're using this as an opportunity to level up the UI of Owncast, so all ideas are welcome.

See the extra how-to guide for components here: Components How-to.

Run the web project

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.

Next, start the web project with npm.

npm run dev

Update the project

You can add or edit a pages by modifying pages/something.js. The page auto-updates as you edit the file.

Routes will automatically be available for this new page components.

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/

Admin Authentication

The pages under /admin require authentication to make API calls.

Auth: HTTP Basic

username: admin

pw: [your streamkey]

Learn More

To learn more about Next.js, take a look at the following resources: