owncast/web
2022-11-29 16:05:44 -08:00
..
.storybook Support color customization from the admin (#2338) 2022-11-12 20:26:55 -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 Add some images+icons to assets section 2022-05-09 19:02:10 -07:00
components Updates to the admin to reflect new stream keys and admin password split 2022-11-29 16:05:44 -08:00
docs Fix web project build errors 2022-05-11 23:31:31 -07:00
interfaces Support color customization from the admin (#2338) 2022-11-12 20:26:55 -08:00
pages Updates to the admin to reflect new stream keys and admin password split 2022-11-29 16:05:44 -08:00
public Add missing federation action images to webv2 (#2266) 2022-10-26 15:22:13 -07:00
services Support customSocketOverride value for websocket. Closes #2225 2022-10-18 20:43:23 -07:00
stories Support color customization from the admin (#2338) 2022-11-12 20:26:55 -08:00
style-definitions Change bright yellow chat user color 2022-11-13 12:52:24 -08:00
styles Chat name & color modal (#2347) 2022-11-23 10:52:39 -08:00
types Updates to the admin to reflect new stream keys and admin password split 2022-11-29 16:05:44 -08:00
utils Updates to the admin to reflect new stream keys and admin password split 2022-11-29 16:05:44 -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 React 18 (#2198) 2022-10-11 22:53:51 -07: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 Set next setting to not try to optimize images 2022-10-28 20:19:11 -07:00
package-lock.json chore(deps): lock file maintenance 2022-11-28 19:14:31 +00:00
package.json chore(deps): update nextjs monorepo to v13.0.5 2022-11-26 14:11:30 +00:00
postcss.config.js First pass at component library 2022-04-25 15:52:38 -07:00
README.md docs: add how-to docs for creating components (#2124) 2022-09-16 09:19:55 -07: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, for 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: