mirror of
https://github.com/owncast/owncast.git
synced 2024-10-25 05:56:00 +03:00
42 lines
1.8 KiB
Markdown
42 lines
1.8 KiB
Markdown
This is a [Next.js](https://nextjs.org/) project with [TypeScript](https://www.typescriptlang.org/), [Sass](https://sass-lang.com/) styling, using [Ant Design](https://ant.design/) UI components.
|
|
|
|
## Getting Started
|
|
|
|
**First**, run the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
# or
|
|
yarn dev
|
|
```
|
|
|
|
**Second**, 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.
|
|
|
|
|
|
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](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](https://nextjs.org/docs/api-reference/next/router) will be available for this new page component.
|
|
|
|
Since this project hits API endpoints you should make requests in [`componentDidMount`](https://reactjs.org/docs/react-component.html#componentdidmount), and not in [`getStaticProps`](https://nextjs.org/docs/basic-features/data-fetching), 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/
|
|
|
|
### Auth-ing for APIs
|
|
Auth: HTTP Basic
|
|
username: admin
|
|
pw: [your streamkey]
|
|
|
|
|
|
## Learn More
|
|
|
|
To learn more about Next.js, take a look at the following resources:
|
|
|
|
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
|
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
|
|
|
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
|
|