https://github.com/jmnarloch/generator-express-sidecar

Yeoman Express generator with Spring Cloud Sidecar setup
https://github.com/jmnarloch/generator-express-sidecar

Last synced: 4 days ago
JSON representation

Yeoman Express generator with Spring Cloud Sidecar setup

• Host: GitHub
• URL: https://github.com/jmnarloch/generator-express-sidecar
• Owner: jmnarloch
• License: mit
• Created: 2015-08-22T17:07:31.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-12T18:47:46.000Z (about 9 years ago)
• Last Synced: 2024-10-04T19:41:40.608Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 516 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-express-sidecar [![Build Status](https://secure.travis-ci.org/jmnarloch/generator-express-sidecar.png?branch=master)](https://travis-ci.org/jmnarloch/generator-express-sidecar) [![npm version](https://badge.fury.io/js/generator-express-sidecar.svg)](http://badge.fury.io/js/generator-express-sidecar) [![Dependency Status](https://david-dm.org/jmnarloch/generator-express-sidecar.svg)](https://david-dm.org/jmnarloch/generator-express-sidecar) [![devDependency Status](https://david-dm.org/jmnarloch/generator-express-sidecar/dev-status.svg)](https://david-dm.org/jmnarloch/generator-express-sidecar#info=devDependencies)

> [Yeoman](http://yeoman.io) [Express](http://expressjs.com) generator with additional [Spring Cloud Sidecar]() setup

The Spring Cloud Sidecar works in two ways it allows your Node application to be discovered by other applications 

through Eureka or Consul, perform health checks etc. On other hand it let you access from inside the Node 

application Eureka for service discovery and address lookup or for instance read the Cloud Config server for

configuration.

## Getting Started

To install generator from npm, run:

```bash

npm install -g generator-express-sidecar

```

Finally, initiate the generator:

```bash

yo express-sidecar

```

## Options

### Application name

The name of the application to be registered in the discovery service.

### Discovery service

The discovery service to use, either Netflix Eureka or Consul.

### Eureka serviceUrl

Allows to specify the serviceUrl to Eureka

### Consul host

The Consul host.

### Consul port

The Consul port.

## Project structure

```

.

├── app

│   ├── app.js

│   ├── bin

│   ├── package.json

│   ├── public

│   ├── routes

│   └── views

└── sidecar

    ├── build.gradle

    ├── gradle

    ├── gradlew

    ├── gradlew.bat

    └── src

```

The `app` directory contains normal Express application, there is nothing special about it.

The `sidecar` has a Spring Cloud Sidecar setup.

## Running

You will need a running Spring Cloud Eureka instance to able to run this application.

First start the Express application:

```bash

$ cd app

$ DEBUG=app:* bin/www

```

Next run Spring Cloud Sidecar

```bash

$ cd sidecar

$ ./gradlew bootRun

```

You should see the application being registered in Eureka:

![Eureka registration](https://github.com/jmnarloch/generator-express-sidecar/raw/master/eureka.png "Eureka registration")

You can access the sidecar application on [http://localhost:5678](http://localhost:5678)

![Sidecar](https://github.com/jmnarloch/generator-express-sidecar/raw/master/sidecar.png "Siedcar")

The application itself runs on [http://localhost:3000](http://localhost:3000) and this is the address that will be 

registered within Eureka.

## Configuration

The `application.yml` sets the home address to be accessed by other applications and the health url:

```yaml

server:

  port: ${PORT:5678}

spring:

  application:

      name: express-sidecar

sidecar:

  port: 3000

  home-page-uri: http://localhost:${sidecar.port}/

  health-uri: http://localhost:${sidecar.port}/health

```

## License

MIT