Giter Club home page Giter Club logo

gateway-manager's Introduction

Gateway Manager UI and backend

This is a sample application based on Spring Boot 2.4 backend and Angular 11 front end.

Prerequisites

  • JDK 8 or later
  • Apache Maven 3.5 or later
  • Node.js (v14.16.0 or compatible)
  • Angular CLI (v11 or compatible)
  • MySQL (v5.7 or compatible)
  • git client

how to run this application

  1. clone this repository using git command or alternatively , you may be able to download ZIP archive and extract it
git clone https://github.com/melanj/gateway-manager.git

  1. Create a database named 'app' (or alternative name) and restore the database.sql file in the project

  2. Update src/main/resources/application.yml file according to MySQL server hostname, database and user credentials

e.g.

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/app?serverTimezone=UTC
    username: root
    password: root
  dbcp2:
    max-wait-millis: 30000
    validation-query: "SELECT 1"
    validation-query-timeout: 30
  jpa:
    hibernate:
      ddl-auto: update
    open-in-view: false
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQL5InnoDBDialect
        jdbc:
          lob:
            non_contextual_creation: true
        id:
          new_generator_mappings: true
springdoc:
  pathsToMatch: /api/**
  1. Use "mvn clean install" to build the package, maven invokes 'ng' command package angular application into Jar file alone with spring boot application.

e.g

$ mvn clean install
[INFO] Scanning for projects...
[INFO] 
[INFO] -------------------< org.example:gateway-admin-app >--------------------
[INFO] Building gateway-admin-app 1.0.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- maven-clean-plugin:3.1.0:clean (default-clean) @ gateway-admin-app ---
[INFO] Deleting /home/melan/wks/app/target
[INFO] 
[INFO] --- exec-maven-plugin:1.2.1:exec (build-angular-app) @ gateway-admin-app ---
- Generating browser application bundles...
✔ Browser application bundle generation complete.
- Copying assets...
✔ Copying assets complete.
- Generating index html...
✔ Index html generation complete.

Initial Chunk Files | Names         |      Size
vendor.js           | vendor        |   3.92 MB
polyfills.js        | polyfills     | 128.79 kB
main.js             | main          |  85.18 kB
styles.css          | styles        |  74.05 kB
runtime.js          | runtime       |   6.15 kB

| Initial Total |   4.21 MB

Build at: 2021-04-08T12:11:01.143Z - Hash: 656f7e0e131654deb9d2 - Time: 10148ms
[INFO] 
[INFO] --- maven-resources-plugin:3.2.0:resources (default-resources) @ gateway-admin-app ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Using 'UTF-8' encoding to copy filtered properties files.
[INFO] Copying 13 resources
[INFO] 
[INFO] --- maven-compiler-plugin:3.8.1:compile (default-compile) @ gateway-admin-app ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 19 source files to /home/melan/wks/app/target/classes
[INFO] 
[INFO] --- maven-resources-plugin:3.2.0:testResources (default-testResources) @ gateway-admin-app ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Using 'UTF-8' encoding to copy filtered properties files.
[INFO] skip non existing resourceDirectory /home/melan/wks/app/src/test/resources
[INFO] 
[INFO] --- maven-compiler-plugin:3.8.1:testCompile (default-testCompile) @ gateway-admin-app ---
[INFO] No sources to compile
[INFO] 
[INFO] --- maven-surefire-plugin:2.22.2:test (default-test) @ gateway-admin-app ---
[INFO] No tests to run.
[INFO] 
[INFO] --- maven-jar-plugin:3.2.0:jar (default-jar) @ gateway-admin-app ---
[INFO] Building jar: /home/melan/wks/app/target/gateway-admin-app-1.0.0-SNAPSHOT.jar
[INFO] 
[INFO] --- spring-boot-maven-plugin:2.4.4:repackage (repackage) @ gateway-admin-app ---
[INFO] Replacing main artifact with repackaged archive
[INFO] 
[INFO] --- maven-install-plugin:2.5.2:install (default-install) @ gateway-admin-app ---
[INFO] Installing /home/melan/wks/app/target/gateway-admin-app-1.0.0-SNAPSHOT.jar to /home/melan/.m2/repository/org/example/gateway-admin-app/1.0.0-SNAPSHOT/gateway-admin-app-1.0.0-SNAPSHOT.jar
[INFO] Installing /home/melan/wks/app/pom.xml to /home/melan/.m2/repository/org/example/gateway-admin-app/1.0.0-SNAPSHOT/gateway-admin-app-1.0.0-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  20.445 s
[INFO] Finished at: 2021-04-08T17:41:07+05:30
[INFO] ------------------------------------------------------------------------
  1. use "java -jar target/gateway-admin-app-1.0.0-SNAPSHOT.jar" run the application and application can be accessible via a browser using http://localhost:8080/ and swagger API specifications http://localhost:8080/swagger-ui.html

application logs can be seen in console

$ java -jar target/gateway-admin-app-1.0.0-SNAPSHOT.jar 

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.4.4)

2021-04-08 17:41:25.266  INFO 14310 --- [           main] org.example.app.AppApplication           : Starting AppApplication v1.0.0-SNAPSHOT using Java 11.0.10 on sequoia with PID 14310 (/home/melan/wks/app/target/gateway-admin-app-1.0.0-SNAPSHOT.jar started by melan in /home/melan/wks/app)
2021-04-08 17:41:25.273  INFO 14310 --- [           main] org.example.app.AppApplication           : No active profile set, falling back to default profiles: default
2021-04-08 17:41:26.270  INFO 14310 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Bootstrapping Spring Data JPA repositories in DEFAULT mode.
2021-04-08 17:41:26.352  INFO 14310 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Finished Spring Data repository scanning in 69 ms. Found 2 JPA repository interfaces.
2021-04-08 17:41:27.499  INFO 14310 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2021-04-08 17:41:27.523  INFO 14310 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2021-04-08 17:41:27.524  INFO 14310 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.44]
2021-04-08 17:41:27.622  INFO 14310 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2021-04-08 17:41:27.623  INFO 14310 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 2249 ms
2021-04-08 17:41:27.928  INFO 14310 --- [           main] o.hibernate.jpa.internal.util.LogHelper  : HHH000204: Processing PersistenceUnitInfo [name: default]
2021-04-08 17:41:28.028  INFO 14310 --- [           main] org.hibernate.Version                    : HHH000412: Hibernate ORM core version 5.4.29.Final
2021-04-08 17:41:28.232  INFO 14310 --- [           main] o.hibernate.annotations.common.Version   : HCANN000001: Hibernate Commons Annotations {5.1.2.Final}
2021-04-08 17:41:28.360  INFO 14310 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2021-04-08 17:41:28.828  INFO 14310 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
2021-04-08 17:41:28.856  INFO 14310 --- [           main] org.hibernate.dialect.Dialect            : HHH000400: Using dialect: org.hibernate.dialect.MySQL5InnoDBDialect
2021-04-08 17:41:29.777  INFO 14310 --- [           main] o.h.e.t.j.p.i.JtaPlatformInitiator       : HHH000490: Using JtaPlatform implementation: [org.hibernate.engine.transaction.jta.platform.internal.NoJtaPlatform]
2021-04-08 17:41:29.787  INFO 14310 --- [           main] j.LocalContainerEntityManagerFactoryBean : Initialized JPA EntityManagerFactory for persistence unit 'default'
2021-04-08 17:41:30.685  INFO 14310 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2021-04-08 17:41:30.940  INFO 14310 --- [           main] o.s.b.a.w.s.WelcomePageHandlerMapping    : Adding welcome page: class path resource [public/index.html]
2021-04-08 17:41:31.966  INFO 14310 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2021-04-08 17:41:31.979  INFO 14310 --- [           main] org.example.app.AppApplication           : Started AppApplication in 7.562 seconds (JVM running for 8.278)
2021-04-08 17:42:08.778  INFO 14310 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2021-04-08 17:42:08.778  INFO 14310 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2021-04-08 17:42:08.779  INFO 14310 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 1 ms
2021-04-08 17:58:29.445  INFO 14310 --- [io-8080-exec-10] o.springdoc.api.AbstractOpenApiResource  : Init duration for springdoc-openapi is: 680 ms

how to see coverage

Tests can be run using following maven command and test reports are available at 'target/site/jacoco/index.html'

mvn clean test jacoco:report

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.