LogalDeveloper/owncast
LogalDeveloper/owncast
0
Fork 0
Code

Fix clarifications of backend vs. frontend source in readme

Browse Source
This commit is contained in:
Gabe Kangas 2022-05-13 12:56:13 -07:00
parent de4ed9bb62
commit 4b2742739a
No known key found for this signature in database
GPG Key ID: 9A56337728BC81EA
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -74,6 +74,10 @@ OBS, Streamlabs, Restream and many others have been used with Owncast. [Read mor
## Building from Source ## Building from Source
### Backend
The Owncast backend is a service written in Go.
1. Ensure you have the gcc compiler installed. 1. Ensure you have the gcc compiler installed.
1. Install the [Go toolchain](https://golang.org/dl/) (1.16 or above). 1. Install the [Go toolchain](https://golang.org/dl/) (1.16 or above).
1. Clone the repo. `git clone https://github.com/owncast/owncast` 1. Clone the repo. `git clone https://github.com/owncast/owncast`
@ -83,14 +87,9 @@ OBS, Streamlabs, Restream and many others have been used with Owncast. [Read mor
There is also a supplied `Dockerfile` so you can spin it up from source with little effort. [Read more about running from source](https://owncast.online/docs/building/). There is also a supplied `Dockerfile` so you can spin it up from source with little effort. [Read more about running from source](https://owncast.online/docs/building/).
### Bundling in latest admin from source ### Frontend
The admin ui is built at: https://github.com/owncast/owncast-admin it is bundled into the final binary using pkger. The Owncast [Web Frontend](web/) is a React application that is worked on seperately from the backend. Visit the [web readme](web/README.md) for details.
To bundle in the latest admin UI:
1. From the owncast directory run the packager script: `./build/admin/bundleAdmin.sh`
1. Compile or run like above. `go run main.go`
## Contributing ## Contributing
@ -104,7 +103,7 @@ There is a larger, more detailed, and more up-to-date [guide for helping contrib
### Architecture ### Architecture
Owncast consists of two repositories with two standalone projects. [The repo you're looking at now](https://github.com/owncast/owncast) is the core repository with the backend and frontend. [owncast/owncast-admin](https://github.com/owncast/owncast-admin) is an additional web project that is built separately and used for configuration and management of an Owncast server. Owncast consists of two repositories with two standalone projects. [The repo you're looking at now](https://github.com/owncast/owncast) is the core repository with the backend and frontend.
### Suggestions when working with the Owncast codebase ### Suggestions when working with the Owncast codebase