Skip to content
Snippets Groups Projects
README.md 2.14 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Stackspin Dashboard
    
    Luka's avatar
    Luka committed
    
    
    This repo hosts the Stackspin Dashboard frontend code.
    The backend code is located at
    <https://open.greenhost.net/stackspin/dashboard-backend>.
    
    Luka's avatar
    Luka committed
    
    
    ## Development environment
    
    Luka's avatar
    Luka committed
    
    
    ### Setup
    
    Luka's avatar
    Luka committed
    
    
    Create a `.env` file in the project root directory:
    
    Luka's avatar
    Luka committed
    
    
        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.
    
    Luka's avatar
    Luka committed
    Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
    
    
    The page will reload if you make edits.
    
    Luka's avatar
    Luka committed
    You will also see any lint errors in the console.
    
    
    #### `yarn test`
    
    Luka's avatar
    Luka committed
    
    
    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.
    
    Luka's avatar
    Luka committed
    
    
    #### `yarn build`
    
    Luka's avatar
    Luka committed
    
    
    Builds the app for production to the `build` folder.
    It correctly bundles React in production mode and optimizes the build
    for the best performance.
    
    Luka's avatar
    Luka committed
    
    
    The build is minified and the filenames include the hashes.
    
    Luka's avatar
    Luka committed
    Your app is ready to be deployed!
    
    
    See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment)
    for more information.
    
    Luka's avatar
    Luka committed
    
    
    #### `yarn eject`
    
    Luka's avatar
    Luka committed
    
    **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.
    
    Luka's avatar
    Luka committed
    
    
    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.
    
    Luka's avatar
    Luka committed
    
    
    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.
    
    Luka's avatar
    Luka committed
    
    ## Learn More
    
    You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).