LIGHT

  • News
  • Docs
  • Community
  • Reddit
  • GitHub
Star

Tutorial

The light platform is aiming enterprise-scale microservices, and there are too many moving parts. The general feedback from our users is that it is hard to learn especially for Java EE developers. Even there are a lot of examples in light-example-4j repository and we have so many infrastructure services built on the platform like light-oauth2, light-portal, light-proxy and [light-rotuer][], a lot of beginners still don’t know where to get started.

To help our users, we have written tutorials that cover almost every perspective of the platform. These tutorials can be found at document site and the repository is light-doc.

If you are contributing examples in light-example-4j, instead of writing a README.md to introduce your project, it is highly recommended that you write a tutorial for your project. In the process, you will learn more as you have to rethink all the details. For other people who are good writers, we need your help to write tutorials based on examples or write blogs about your experiences in using the platform.

Getting started

  • Make sure you have a GitHub account
  • It recommended to create a ticket in light-example-4j before adding a tutorial source directory so that other people can learn more about the tutorial.
  • Fork light-example-4j repository on Github
  • Fork light-doc repository on Github

Making Changes

  • Push your changes to a topic branch in your light-example-4j fork of the repository.
  • Write a README.md in the folder of your tutorial for other people to learn how to use your tutorial.
  • Update tutorial section in light-doc fork repository to explain your tutorial in detail.
  • Submit a pull request to the light-example-4j repository in the networknt organization.
  • Submit a pull request to the light-doc repository in the networknt organization.
  • The core team looks at Pull Requests on a regular basis and will merge the pull request.
  • Sometimes, we might need to contact contributor understand the details of the pull request.
  • About Light Platform
    • Overview
    • What is Light
    • Features
    • Benefits
    • Principles
    • Roadmap
    • 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
  • 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
    • Configs References
  • API Styles
    • 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
    • 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
    • Hugo Docs
    • Hugo Site
    • Hugo Netlify
    • Java keytool
    • Memory Monitoring
    • OpenAPI Parser
    • Minikube
    • Wrk
    • Light Bot
    • Light Codegen Reference
    • Kubernetes
  • 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
  • Example
    • Example Overview
  • Tutorial
    • Tutorial Overview
    • Client Tutorial
    • Common Tutorial
    • Registry and Discovery
    • Middleware Handlers
    • OpenAPI 3.0 Petstore
    • Security Tutorial
    • Swagger 2.0 Petstore
    • Test light service
    • Light Codegen Tutorial
    • Restful Database Access
    • Light Oauth2 Tutorial
    • Microservices Chain Pattern
    • GraphQL Tutorial
    • Handler Routing Tutorial
    • Microservices Aggregate Pattern
    • Restful Tutorial
    • Hybrid Tutorial
    • Light Bot Tutorial
    • Microservices Branch Pattern
    • Tram Tutorial
    • Eventuate Tutorial
    • Light Portal Tutorial
    • Light Proxy Tutorial
    • Light Router Tutorial
  • Benchmark
    • Benchmark Overview
  • Troubleshooting
    • Troubleshoot
  • FAQ
    • FAQ Overview
  • Milestones
  • Contribute
    • Contribute to Light
    • Development
    • Documentation
    • Example
    • Tutorial
“Tutorial” was last updated: February 2, 2019: update contribution process (5b38181)
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
  • Example
  • Tutorial
  • Benchmark
  • Troubleshooting
  • FAQ
  • Milestones
  • Contribute