local-it
/
dashboard
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Lint README.md, document .env file usgae

main
Varac 2022-06-16 12:33:03 +02:00
parent 6eec663a07
commit 7cc1b63365
No known key found for this signature in database
GPG Key ID: 5465E77E7876ED04
1 changed files with 40 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -1,46 +1,65 @@
# Getting Started with Create React App
# Stackspin Dashboard
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This repo hosts the Stackspin Dashboard frontend code.
The backend code is located at
<https://open.greenhost.net/stackspin/dashboard-backend>.
## Available Scripts
## Development environment
In the project directory, you can run:
### Setup
### `yarn start`
Create a `.env` file in the project root directory:
Runs the app in the development mode.\
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.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
The page will reload if you make edits.
You will also see any lint errors in the console.
### `yarn test`
#### `yarn test`
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.
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.
### `yarn build`
#### `yarn build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build
for the best performance.
The build is minified and the filenames include the hashes.\
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment)
for more information.
### `yarn eject`
#### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t 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.
If you aren’t 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.
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 you’re on your own.
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 you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You don’t have to ever use `eject`. The curated feature set is suitable for
small and middle deployments, and you shouldn’t feel obligated
to use this feature.
However we understand that this tool wouldn’t be useful
if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).