GeneSys

"Genesis + System = GeneSys"

---

Table of contents

• GeneSys
  • Description
  • SETUP
  • TODOs, WIP & FUTURE DEVELOPMENT
  • NOTES
  • LICENSE
  • CONSTRUCTIVE FEEDBACK AND CONTRIBUTIONS TO THE PROJECT ARE WELCOME
• REFERENCES

---

Description

This is a project to be used as a base or a cookie cutter if you will.

This version of the project is for building Java, Spring Boot Web and REST applications from scratch.

The project comes incorporating or pre-configured to be compatible with the following technologies:

• Java
• Spring
• Spring Boot
  • Spring Cloud
• Aspect Oriented Programming (AOP)
  • Spring AOP
  • AspectJ
• Web & REST
  • Spring MVC
    • Controllers
    • Filters
    • Exception Handling
  • Thymeleaf templates
    • HTML
    • CSS
• Testing
  • Spring Boot Test
    • JUnit
    • Unit Testing
    • Integration Testing
• Spring Data
  • MySQL
  • JPA
  • DAO
• Logging
  • Structured Logging in JSON format
  • Logback
  • SLF4J
    • MDC
  • Logstash
• Distributed Tracing
  • Spring Cloud Sleuth
  • Zipkin
• Apache Maven
  • Apache Maven Enforcer plugin
• Apache Tomcat
• Design Patterns
  • Builder Design Pattern
• Lombok
• Google Guava
• Docker
  • Docker-compose
• Kubernetes

Note: For the relevant versions, please see the POM file.

---

SETUP

• Setting up the Maven wrapper

mvn -N io.takari:maven:wrapper

• Building

mvn clean install

• Running

  • Maven

  mvn spring-boot:run

  • Docker & Docker-Compose

  docker-compose up --build --remove-orphans

---

TODOs, WIP & FUTURE DEVELOPMENT

• ⬜ Clean up & tidy up.

• ✴️ Create a demo application.

• ⬜ Add more useful technologies.

• ⬜ Add profiles for different environments.

• ⬜ Obfuscate logging for security.

• ⬜ Add Spring Boot Security

⬜ - Not started. ✴️ - In progress. ✅ - Done.

---

NOTES

APPENDIX A

---

LICENSE

GPL-3.0 License

---

CONSTRUCTIVE FEEDBACK AND CONTRIBUTIONS TO THE PROJECT ARE WELCOME

Contact

---

REFERENCES

https://spring.io/

http://patorjk.com/software/taag/#p=display&f=Graffiti&t=Type%20Something%20

---