Local Setup Guide

Prerequisites

• Maven version >= 3.5.4
• Java 8
• MongoDB version >= 4.0.5

Get Started

1. run the init-script, it will clone the related projects

2. Go into the service-eureka-server project and execute following commands

mvn clean spring-boot:run -Dspring.profiles.active=dev

After the application started up, please check Eureka server page is on

3. Go into the service-config-server project and execute following commands

mvn clean spring-boot:run -Dspring.profiles.active=dev

After the application started up, please go to Eureka server page and check application is registered in Eureka

4. Start the MongoDB instance with Docker (if you want to create that on local, please go to 4.1)

Go into the mongodb-docker-template project, build the image with Dockerfile-dev and run it

Example for service-jobad-reader:

cd ./mongodb-docker-template/service-jobad-reader
docker build -f Dockerfile-dev .
docker run -p 37017:27017 -d ${please-replace-with-image-id}

4.1. Start the MongoDB instance on local

Start up a local MongoDB instance on port 37017

mongod --port 37017

Connect it with MongoDB Shell and paste the script

mongo --port 37017

5. Starting others services

Go into the service-jobad-reader, service-eureka-scheduler, service-zuul-server projects and repeat the steps of starting service-config-server

service-rss-reader local version is in the development, thanks!

Get Started (docker-compose)

1. Run Server

docker-compose -f docker-compose-dev-server.yml up --build

2. Run Service

export BRIDGE_NETWORK=$(docker inspect service-overview_bridge-network | grep '"Gateway"' | head -n 1 | grep -o '[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}')
docker-compose -f docker-compose-dev-service.yml up --build

3. Run UI

cd ../service-search-ui
npm install
ng serve

service-overview

Communicating between Microservices

Service

service-search-ui - An Angular search UI with docker image. Demo site

service-eureka-server - A eureka server with docker image.

service-zuul-server - A proxy zuul server for frontend.

service-config-server - A spring cloud config server with git registry and docker image.

service-rss-reader - A eureka client to fetch rss.

service-eureka-scheduler - A fixed rate scheduler to call other eureka client with restTemplate, ribbon and hystrix.

service-jobad-reader - A reader to parse rss and search.

Pipeline

TODO List

• [] Release page
• [] docker compose
• [] add dev env
• add development guide
• add development init script