LIGHT

  • News
  • Docs
  • Community
  • Reddit
  • GitHub
Star

Prepare Environment

Before starting portal services locally, we need to make sure that docker is installed. This tutorial is based on Ubuntu Linux, and I am sure that Mac OS should work the same. However, I am not sure that it will work on Windows. It would be great if someone can help to test it on the Windows environment.

Check out

We have docker-compose and config files checked into some repositories on the GitHub.com, and we need to check out these repositories. If you want to make a code change for one of the light-portal services, then you need to check out more repositories and build docker images locally.

As usual, I am using networknt under my home directory as the workspace.

cd ~/networknt
git clone https://github.com/networknt/light-docker.git
git clone https://github.com/networknt/light-config-test.git
git clone https://github.com/networknt/light-portal.git

light-docker contains most commonly used docker compose files and their config files. light-config-test contains vary config files and script for daily development and test/prod deployment. light-portal contains the view that is a React SPA to access the services through the router.

/etc/hosts

When we use the consul for service discovery, we need to use docker host network, and all the services will be bound to the same IP/host with different ports. In order to simplify the service reference and later we can use the domain name to access the SPA from the browser, let’s create a hostname lightapi.net in the /etc/hosts to point to the network address.

First, use the following command to find out your local network IP address.

ifconfig

The local IP address is 192.168.1.144 on my desktop. You cannot use the 127.0.0.1 or localhost as they mean local address within a Docker container.

Now, let’s add a line into the /etc/hosts file with sudo vi /etc/hosts

192.168.1.144   lightapi.net

Note that your local IP address might be different than mine. Please update the above line accordingly.

In the next step, we are going to start a consul container to mimic a consul cluster on a test/prod environment.

  • About Light Platform
    • Overview
    • Testimonials
    • What is Light
    • Features
    • Principles
    • Benefits
    • Roadmap
    • Community
    • Articles
    • Videos
    • License
  • Getting Started
    • Get Started Overview
    • Environment
    • Light Codegen Tool
    • Light Rest 4j
    • Light Tram 4j
    • Light Graphql 4j
    • Light Hybrid 4j
    • Light Eventuate 4j
    • Light Oauth2
    • Light Portal Service
    • Light Proxy Server
    • Light Router Server
    • Light Config Server
    • Light Saga 4j
    • Light Session 4j
    • Webserver
    • Websocket
    • Spring Boot Servlet
  • Architecture
    • Architecture Overview
    • API Category
    • API Gateway
    • Architecture Patterns
    • CQRS
    • Eco System
    • Event Sourcing
    • Fail Fast vs Fail Slow
    • Integration Patterns
    • JavaEE declining
    • Key Distribution
    • Microservices Architecture
    • Microservices Monitoring
    • Microservices Security
    • Microservices Traceability
    • Modular Monolith
    • Platform Ecosystem
    • Plugin Architecture
    • SOA
    • Scalability and Performance
    • Serverless
    • Service Collaboration
    • Service Mesh
    • Spring is bloated
    • Stages of API Adoption
    • Transaction Management
    • Microservices Cross-cutting Concerns Options
    • Service Mesh Plus
    • Service Discovery
  • Design
    • Design Overview
    • Design First vs Code First
    • Desgin Pattern
    • Service Evolution
    • Consumer Contract and Consumer Driven Contract
    • Handling Partial Failure
    • Idempotency
    • Environment Segregation
    • Multi-Tenancy
    • Why check token expiration
    • WebServices to Microservices
  • Cross-Cutting Concerns
    • Concerns Overview
  • API Styles
    • Light-4j for absolute performance
    • Style Overview
    • Distributed session on IMDG
    • Eventuate - Event Sourcing and CQRS
    • Hybrid - Modularized Monolithic
    • REST - Representational state transfer
    • Saga - Distributed Transactions
    • Tram - Transactional Messaging
    • Web Server with Light Platform
    • Websocket with light platform
    • Spring Boot Integration
    • Single Page Application
    • GraphQL - A query language for your API
  • Infrastructure Services
    • Service Overview
    • Light Proxy
    • Light Router
    • Introduction
    • Architecture
    • Light Portal
    • Messaging Infrastructure
    • Centralized Logging
    • Light OAuth2
    • Services
    • Metrics and Alerts
    • Reference
    • Config Server
    • Tokenization
  • Tool Chain
    • Tool Chain Overview
  • Utility Library
  • Service Consumer
    • Service Consumer
  • Development
    • Development Overview
    • Best Practices
    • Development Flow
    • Platform Developer
    • Develop Build
    • Application
    • Service Provider Developer
    • Service Consumer Developer
  • Deployment
    • Deployment Overview
    • Frontend Backend
    • Linux Service
    • Windows Service
    • Install Eventuate on Windows
    • Secure API
    • Client vs light-router
    • Memory Limit
    • Deploy to Kubernetes
  • Benchmark
    • Benchmark Overview
  • Tutorial
    • Tutorial Overview
  • Troubleshooting
    • Troubleshoot
  • FAQ
    • FAQ Overview
  • Milestones
  • Contribute
    • Contribute to Light
    • Development
    • Documentation
    • Example
    • Tutorial
“Prepare Environment” was last updated: May 2, 2019: fixes #80 add local-router tutorial for portal development (5dfdd63)
Improve this page
  • News
  • Docs
  • Community
  • Reddit
  • GitHub
  • About Light Platform
  • Getting Started
  • Architecture
  • Design
  • Cross-Cutting Concerns
  • API Styles
  • Infrastructure Services
  • Tool Chain
  • Utility Library
  • Service Consumer
  • Development
  • Deployment
  • Benchmark
  • Tutorial
  • Troubleshooting
  • FAQ
  • Milestones
  • Contribute