Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tgstation/tgstation-server-webpanel
React application for interacting with tgstation-server
https://github.com/tgstation/tgstation-server-webpanel
client generated-api tgstation tgstation-server typescript webpack
Last synced: about 1 month ago
JSON representation
React application for interacting with tgstation-server
- Host: GitHub
- URL: https://github.com/tgstation/tgstation-server-webpanel
- Owner: tgstation
- License: agpl-3.0
- Created: 2018-10-19T20:24:08.000Z (about 6 years ago)
- Default Branch: next
- Last Pushed: 2024-10-29T11:13:22.000Z (2 months ago)
- Last Synced: 2024-10-29T13:10:00.934Z (2 months ago)
- Topics: client, generated-api, tgstation, tgstation-server, typescript, webpack
- Language: TypeScript
- Homepage:
- Size: 38.5 MB
- Stars: 10
- Watchers: 7
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# TGS Webpanel
React web app to control TGS
| CI Badges | |
| --------- | ----------------------------------------------------------------------------------------------------------- |
| Linting |  |
## Currently supported browsers
last 5 chrome version
last 5 firefox version
last 3 edge version
last 5 opera version
last 3 safari version
## Install
1. Install Node.JS from
2. Install yarn by `corepack enable`
3. Clone this repository
4. Run `yarn` or `yarn install` on the cloned repository
## Development
To run a test server, make sure you have ran `yarn` or `yarn install` beforehand to install dependencies then simply run `yarn start`, the first build may take anywhere from a dozen of seconds to 2 minutes depending on your machine but subsequent changes to the file system will get picked up by the dev server and those will usually be built much faster. The app will hot swap components.
Make sure to run `yarn` or `yarn install` again if you pull in new changes from the repo
## Scripts
| | |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| start | Starts a development server that listens on `0.0.0.0:8080` The server will watch for changes in the file system to recompile |
| generate-api | Redownloads the api spec from tgstation-server and generates typings and the axios backend. |
| build | Builds a production version in `/dist` |
| lint | Runs eslint on the codebase to check for errors |
| lint-fix | Runs eslint on the codebase to check for errors but also attempts to fix said errors |
| build-dev | Builds a development version in `/dist` |
| | |
## License
This work is licensed under AGPL-3.0. See the LICENSE file for more information.