An open API service indexing awesome lists of open source software.

https://github.com/robphoenix/hydro-web


https://github.com/robphoenix/hydro-web

Last synced: 13 days ago
JSON representation

Awesome Lists containing this project

README

          

![hydro logo](/src/assets/img/hydro-power.png)

[![Build Status](https://mn2forbld0001d0/view/All%20jobs/job/hydro-web-pipeline/job/master/badge/icon?style=flat-square)](https://mn2forbld0001d0/view/All%20jobs/job/hydro-web-pipeline/job/master/)

# Hydro Web

- [Hydro Web](#hydro-web)
- [Install](#install)
- [Local Development](#local-development)
- [Design & CSS](#design--css)
- [Dev server](#dev-server)
- [Server scripts](#server-scripts)
- [CI](#ci)

## Install

Clone this repo to your local machine and run `npm install` to install all
dependencies. This will also install Angular & TypeScript to the local
project, so you _shouldn't_ need to have them already installed globally.

## Local Development

Run `npm start` to start up the app, and then navigate to
[http://localhost:4200/](http://localhost:4200/). The app will automatically
reload if you change any of the source files.

## Design System

In the Sass files you will find predefined colours, typography settings, and padding & margin spacings. These should help with the overall rhythm and design of the site.

## DEV server

A dev instance of Hydro is available on
[mn2splmfe001sd0](http://mn2splmfe001sd0:4200). The Angular app here is
served up by the small Go server in `/server`. Due to the limitations with
this deep links will not work on the DEV server.

### Server scripts

- **server/deploy.sh** will build and deploy the Go web server to the DEV instance.
- **server/run.sh** will run the Go web server in the background, this is to be used on any remote servers that are expected to serve the application.

## POC Server

## CI

The [hydro-web-pipeline](https://mn2forbld0001d0/job/hydro-web-pipeline/)
Jenkins job will run formatting & linting checks. It will also build and
deploy to DEV, as well as the small Go server that will serve the
app. It can be triggered by Merge Requests, pushes to open Merge Requests,
and manually for any available branch.