This is the repo for the scheduler_ui, It plugs into the Scheduler_backend's API and helps manage tasks server authentication, proxies, and more.
The scheduler_ui offers localstorage saves for target servers allowing for runtime server changes, so you can host multiple backends and manage them using a single instance of the UI, more on that below.
- Authenticating to backend server
- Managing Tasks (Aka Jobs)
- Managing Proxies
- Managing Databases
- ...
- Deploying The UI is done best when using Docker, a
DOCKERFILE
is provided with an nginx Reverse Proxy serving the built UI. - A
compose.yml
file is also provided just for reference, some environment variables are accepted during build time,
Variable Name | Description | Default Value |
---|---|---|
SERVER_ENDPOINT | The endpoint of the target server | / |
Using the UI is as simple as running docker with the compose file.
docker compose up
to run the container in command line you can use the followign command :
docker run -p 80:80 ghcr.io/moda20/scheduler_ui:latest
The best way to use the scheduler_ui is to deploy it alongside an instance of the scheduler_backend. (see the starter repo)
The frontend is built using vite and react, redux/react-redux, and shadcn, and tailwindcss are used for components and styling.
To run the frontend app locally :
- Clone the repo :
git clone https://github.com/moda20/scheduler_ui.git
- Install the dependencies :
npm install
- Run the app :
npm start
- to build the app run :
npm run build
The app is self contained and will not need any extra configurations
TBD
Contributions are welcome! Please feel free to open an issue or submit a pull request. Please take the time to debug your issues and test your pull request changes if they need to, adding runnable tests would be much appreciated.