dashboard/README.md

66 lines
2.1 KiB
Markdown
Raw Normal View History

# Stackspin Dashboard
2021-09-27 12:17:33 +02:00
This repo hosts the Stackspin Dashboard frontend code.
The backend code is located at
<https://open.greenhost.net/stackspin/dashboard-backend>.
2021-09-27 12:17:33 +02:00
## Development environment
2021-09-27 12:17:33 +02:00
### Setup
2021-09-27 12:17:33 +02:00
Create a `.env` file in the project root directory:
2021-09-27 12:17:33 +02:00
cp .env.example .env
and adjust the `REACT_APP_HYDRA_PUBLIC_URL` to the SSO URL of your cluster.
#### `yarn start`
Runs the app in the development mode.
2021-09-27 12:17:33 +02:00
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
2021-09-27 12:17:33 +02:00
You will also see any lint errors in the console.
#### `yarn test`
2021-09-27 12:17:33 +02:00
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests)
for more information.
2021-09-27 12:17:33 +02:00
#### `yarn build`
2021-09-27 12:17:33 +02:00
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build
for the best performance.
2021-09-27 12:17:33 +02:00
The build is minified and the filenames include the hashes.
2021-09-27 12:17:33 +02:00
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment)
for more information.
2021-09-27 12:17:33 +02:00
#### `yarn eject`
2021-09-27 12:17:33 +02:00
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
If you arent satisfied with the build tool and configuration choices,
you can `eject` at any time. This command will remove the single build dependency
from your project.
2021-09-27 12:17:33 +02:00
Instead, it will copy all the configuration files and the transitive dependencies
(webpack, Babel, ESLint, etc) right into your project so you have full control
over them.
All of the commands except `eject` will still work, but they will point to the
copied scripts so you can tweak them. At this point youre on your own.
2021-09-27 12:17:33 +02:00
You dont have to ever use `eject`. The curated feature set is suitable for
small and middle deployments, and you shouldnt feel obligated
to use this feature.
However we understand that this tool wouldnt be useful
if you couldnt customize it when you are ready for it.
2021-09-27 12:17:33 +02:00
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).