When I design and develop an enterprise application I leverage the knowledge and experiences from past projects to piece together the initial commit with an architecture and set of libraries that have worked well for me. Regardless of the numerous applications that I have developed, the initial setup and commit always seems to take too long. That's always been a source of frustration for me. The Big Code Bang project was created to expedite the process of creating a new enterprise web application, generating the source code for both the server side and client side projects using a proven architecture that can be built upon. The result is a working web application architected with a time-tested technology stack and ready to be imported into your IDE and checked into your code repository.
The generated source code is yours to build upon, saving weeks, if not months of time and money.
Go ahead and give it a BIG code bang! :-)
--Doug Estep
Architecting an enterprise web project can be complex and involves many decision points.
- What server platform? Linux, Windows, etc.? Clustered or non clustered environment? If clustered then a load balancer will be needed (F5 Big-IP, etc.).
- What server-side software technology stack? Java, .NET, NodeJS, etc.? This decision may be based on your server platform. For example, if you want a .NET technology stack then it most likely needs to run on Windows. (.NET core runs on any OS). If you choose a Java technology stack then you have library choices, such as Spring, EJB, etc.
- What software platform for the view into your web application? Do you want a single page application or a
traditional request/response application? If you want a single page application, then you have framework choices;
Angular, JQuery, Backbone, etc., or a controller stack such as Spring MVC in Java or a .NET backed controller.
If you choose the single page application approach then there are more tools to decide on and learn; Bower, Gulp, NodeJS, Node Package Manager (NPM), and more. (Lot's of moving parts for sure). - What about security technologies? Authentication and authorization. LDAP, Active Directory, emdedded authentication/authorization, the honor system -- kidding :-).
- Logging libraries? Log4j or Log4N for .NET, etc.
- What Database? Structured data or big data? An ORM such as Hibernate or EclipseLink for Java or the entity framework for .NET. Or... go it old school and do straight JDBC or ODBC (don't mock... sometimes there's a valid use-case for old school).
- What application server will your web application run in? Apache Tomcat, IBM Websphere, Oracle Weblogic, JBoss, IIS for .NET, etc.
Once you have decided on the technology stack, the next step is to setup the tools and processes necessary for the software development process.
- Setup a build script to build your application, including source code checks for style, code analyzers such as PMD and FindBugs, and tools to report code coverage. The choices differ based on your choice of server side technologies to which your application will be written.
- Setting up a continuous integration environment using applications such as Jenkins, etc.
- Picking a code repository, such as GIT, Subversion, Team Foundation Server (TFS), etc.
- Deciding on a tool for bug and issue tracking and project management tools such as Jira by Atlassian, etc.
- Training developers on the tools and technologies that you have selected.
As an architect, doing your due diligence on each of these decision points is crucial for a successful and secure application. However, doing so usually takes a considerable amount of time and money.
Although I have done some work using Microsoft's technologies, the majority of my career has been programming in Java. I have done some work with NodeJS on the server as well. Any of these choices are fine for the server-side and all have their pros and cons. However with this initial rollout of the Big Code Bang project, Java will be used as the server-side technology.
The tools and libraries the Big Code Bang Project uses/generates are described below:
- Spring - an application framework and inversion of control container for the Java platform. Spring is used to aid in the creation of the REST services, controlling Security, and database access using Spring ORM and Spring JDBC.
- EclipseLink - an open source Eclipse Persistence Services Project from the Eclipse Foundation. The software provides an extensible framework that allows Java developers to interact with various data services, including databases, web services, Object XML mapping (OXM), and Enterprise Information Systems (EIS).
- Gradle Build Tool an open source build automation system that builds upon the concepts of Apache Ant and Apache Maven. Gradle is used for its dependency management and build capabilities.
- MySQL an open source relational database management system (RDBMS) based on Structured Query Language (SQL). Any database vendor can be used with the Big Code Bang. I chose MySQL because of its ease of use. If you are using a different database vendor, you will need to adjust the SQL create scripts to adhere to your DBMS syntax and adjust the JPA adapter settings in the generated model-spring-context XML file.
- Apache Tomcat version 8+. Used to deploy a Web ARchive (WAR) file to serve up REST services. You're not tied to Tomcat. You can use any application server. I chose Tomcat because of it's ease of use. I describe how to setup a database connection pool in Tomcat. If you choose a different application server, you will need to setup your database connection pool using the instructions provided by your application server.
- JUnit - a unit testing framework for the Java programming language.
- JMockit - An automated testing toolkit and mocking framework for Java.
- A single page application using Angular 4 and Angular Material Design
- Typescript - a typed superset of JavaScript that compiles to plain JavaScript
- Twitter Bootstrap - an open source front-end web framework for designing websites and web applications.
- Font Awesome - a web font containing all the icons from the Twitter Bootstrap framework, and now many more.
- Cascading Style Sheets (CSS) - a style sheet language used for describing the presentation of a document written in a markup language.
- Hypertext Markup Language (HTML)
In order to execute the Big Code Bang, you will need the following:
- The Java Developer Kit (JDK), version 8 or higher (to check, enter java -version from the command prompt).
- A database management system (DBMS). The code is generated to interact with a MySQL database. These instructions assume MySQL is your DBMS.
- A Java servlet container. These instructions assume Apache Tomcat version 8+ is your Java servlet container.
- NodeJS. (to check, enter node -v from the command prompt)
- Node Package Manager (NPM). (to check, enter npm -v from the command prompt)
- Install the Java Developer Kit, version 8 or higher. The JAVA_HOME environment variable is required to be set to the location of the JDK.
- Download and install MySQL Community Edition as well as the MySQL Workbench to efficiently design, manage and document database schemata.
- Install Apache Tomcat version 8+.
- Download the latest release of the source code for this project from the Release Page. The Big Code Bang project contains a series of Groovy scripts, resource files, and a Gradle script.
The Big Code Bang project generates two applications; a server side WAR project used to serve up REST service end points and an HTML application used as the view into the application. There are configuration entries that need to be set before Big Code Bang can generate these projects for you.
The below property values need to be set to generate the server side WAR project. The properties file is located at src/main/resources/server_project.properties
Note: All properties are String values and must be surrounded by double quotes.
| Property | Description | Example Values |
|---|---|---|
| project_base_folder | The file system path where the Server project will be generated by Big Code Bang. If any folder contained within the path does not exist on the file system, the folder will be created. | "/temp/wiley-app" (replace with your file system structure) or "C:\\temp\\wiley-app" for windows. (you need to escape the backslash character using two backslashes) |
| top_level_domain | The top level domain of the company that owns this application. This value, along with the company_name and product_name property values, is used when creating the Java package structure for the generated code. Because this value is used in the Java package structure, it may be adjusted to adhere to Java package naming standards. | "com" or "edu" or "org" |
| company_name | The company name that owns the generated application. This value, along with the top_level_domain and product_name property values, is used when creating the Java package structure for the generated code. Because this value is used in the Java package structure, it may be adjusted to adhere to Java package naming standards. | "acme" |
| product_name | The name of the product or application. This value, along with the top_level_domain and company_name property values, is used when creating the Java package structure for the generated code. Because this value is used in the Java package structure, it may be adjusted to adhere to Java package naming standards. | "roadrunner" |
| company_name_long | The english name for the company that owns the generated code. This value will appear in generated gradle scripts. | "Acme Corporation" |
| java_version | The minimum version of java the application is written for. Can not be less that 1.8. | "1.8" |
| mail_host_name | The host server for sending emails. | "localhost" |
| mail_from_address | The email address that will be used by the application when sending automated emails. | "[email protected]" |
| database_jndi_name | The JNDI name the application uses to connect to the database connection pool. | "jdbc/widgetsDb" |
| database_driver_class | The database driver used to get a connection. | "com.mysql.cj.jdbc.Driver" |
| database_url | The URL to the database used to get a connection. | "jdbc:mysql://localhost/widgetsDb" |
| database_username | The database user name used to get a connection. | "wiley" |
| database_password | The database user password used to get a connection. | "super-genius" |
| code_author | The name to assign as the author of all generated code. | "Wiley Coyote" |
| web_war_name | The name of the generated WAR file which is used to serve up the REST services. | "wiley.war" |
| application_log_file_location | The location for the application log file. | "/temp/logs" or "C:\\temp\\logs" (you need to escape the backslash character using two backslashes). All folders must exist for logging to work. The application does not create the folders at runtime. |
| gradle_version | The version of gradle that you want to use for your application. This application was created with version 3.1. When the Big Code Bang is executed, it downloads the gradle version you specify here (along with all other dependencies that you specify) | "3.1" |
The below property values need to be set to generate the HTML project. The properties file is located at src/main/resources/view_project.properties
Note: All properties are String values and must be surrounded by double quotes.
| Property | Description | Example Values |
|---|---|---|
| project_base_folder | The file system path where the View project will be generated by Big Code Bang. If any folder contained within the path does not exist on the file system, the folder will be created. | "/temp/wiley-app" or "C:\\temp\\wiley-app" for windows. (you need to escape the backslash character using two backslashes) |
| view_root_folder_name | The root folder of the project. | "wiley-view" |
| application_title | The value assigned to the title of the web application. | "Wiley Coyote Road Runner Widgets" |
| context_root | The context root for the web application. | "wiley" |
| localhost_port | The port used when running the REST services application on your local machine. | "8081" |
| localhost_view_port | The port used when running the HTML application on your local NodeJS server. | "4200" |
| server_port | The port used when running the REST services application on the remote java web server. | "80" |
| server_view_port | The port used when running the HTML application on the remote HTTP server. | "80" |
| server_host_name | The host name pointing to the remote server. | "mydomain.com" |
- Open a command prompt or terminal and CD into the folder where the Big Code Bang project was downloaded. You should be in the same folder as this README.md and the gradle build.gradle file.
- Use the appropriate gradle wrapper script to initiate a Big Code Bang. (If on a Mac or linux distribution, ensure the gradlew script has execute privileges)
Note: the first execution will be slower because the gradle wrapper downloads the dependencies it needs to execute. Subsequent executions will be fast because the dependencies are not downloaded again.
cd /path/to/BigCodeBang
// if running from a Mac or a linux distribution
./gradlew generateProjects
// if running from Windows
gradlew.bat generateProjectsThe generated source code is located at the location that you provided in the project_base_folder properties within the resources/server_project.properties and resources/view_project.properties files.
- to delete the projects generated by the Big Code Bang.
cd /path/to/BigCodeBang
// if running from a Mac or a linux distribution
./gradlew deleteProjects
// if running from Windows
gradlew.bat deleteProjects- to generate only the view project.
cd /path/to/BigCodeBang
// if running from a Mac or a linux distribution
./gradlew generateViewProject
// if running from Windows
gradlew.bat generateViewProjectThe Gradle Build Tool is used to build your application and manage its dependencies. It is not necessary for you to download and install Gradle. The Big Code Bang project includes the gradle wrapper, which is a script that downloads gradle for you at runtime, along with all other dependencies. The first execution of the gradle wrapper scripts will be slower because the gradle wrapper downloads the dependencies that are specified in the build.gradle file. Subsequent executions will be fast because the dependencies aren't downloaded again.
The following describe how to import the Model and REST service projects into the Intellij IDE by JetBrains.
- Open Intellij and close all opened projects.
- Choose "Import Project"
- Browse and select the folder where the model project was generated. Using the property values contained within the above server.properties, the model project is located in the /temp/wiley-app/acme-roadrunner folder.
- Select the "Import project from external model" option and select the Gradle model. Click Next.
- Check the options, "Create separate module per source separate" and "Check Use default gradle wrapper (recommended)"
- Click Finish
- Wait until the "Gradle Project Data to Import" window appears and ensure all projects are checked. Click OK.
- Select the "Build/Build Project" menu choice to compile and build the generated application. It should compile and build successfully, however if it doesn't then open the menu option View/Tool Windows/Gradle and click the Refresh button to force a dependency refresh.
- Expand the root project and open the config/readme.txt file and follow the instructions to continue setting up the application in Intellij. These instructions were generated to match your specified server configuration values.
The following describe how to import the Model and REST service projects into the Oxygen release of the Eclipse Java EE IDE.
- Open Eclipse and choose or create a workspace.
- Select the menu option File -> Import...
- Choose the Gradle wizard and choose Existing Gradle Project.
- If you are presented with a welcome screen, click next.
- Browse and select the folder where the model project was generated. Using the property values contained within the above server.properties, the model project is located in the /temp/wiley-app/acme-roadrunner folder. Click Next.
- Select the Gradle wrapper choice for the Gradle distribution. Click Next and then click Finish.
- Right-click on the -web project, choose properties, and then Deployment Assembly.
- Highlight the -applogic, -data, and -shared projects and click the Remove button to remove them from the assembly.
- Click the Add... button.
- Choose Project.
- Highlight all projects and click Finish to re-add them to the assembly.
- Click Apply and Close.
- Right click on the -applogic, -data, -model, and -shared projects individually, choose Project Facets, and ensure that the Java version is set to 1.8.
- Expand the root project and open the config/readme.txt file and follow the instructions to continue setting up the application in Eclipse. These instructions were generated to match your specified server configuration values.
Each generated project contains a suite of unit tests which exercise the code and establish a base to which future unit tests can be built. The "-data" project is the project that reads/writes to the database. In order for these tests to successfully connect to the database, the database connection information must be validated as correct compared to how you created the database. To validate this information, do the following:
- Expand the "-data" project and open the src/test/resources/test-model-spring-context.xml file.
- Locate the dataSource bean entry and validate that the connection information is correct. If it is not correct, the unit tests that interact with the database will fail.
Execute the following from the command prompt to execute the unit tests:
// if running from a Mac or a linux distribution
./gradlew test
// if running from Windows
gradlew.bat testconfig/checkstyle/proj-checkstyle.xml
Checkstyle is a static code analysis tool used in software development for checking if source code complies with coding rules. The generated code conforms to the checkstyle rules defined in the config/checkstyle/proj-checkstyle .xml file. The Gradle build script invokes the checkstyle rules when building the WAR file. If any source code violates a checkstyle rule then the build will fail.
You can run this task manually by executing this command:
// if running from a Mac or a linux distribution
./gradlew checkstyleMain
// if running from Windows
gradlew.bat checkstyleMainThe checkstyle report is generated in the build/reports/checkstyle folder.
config/ruleset/proj-pmd-rules.xml
PMD is a static Java source code analyzer. It uses rule-sets to define when a piece of source is erroneous. PMD includes a set of built-in rules and supports the ability to write custom rules. The generated code conforms to the PMD rules defined in the config/ruleset/proj-pmd-rules.xml file. The Gradle build script invokes the PMD rules when building the WAR file. If any source code violates a PMD rule then the build will fail.
You can run this task manually by executing this command:
// if running from a Mac or a linux distribution
./gradlew pmdMain
// if running from Windows
gradlew.bat pmdMainThe PMD report is generated in the build/reports/pmd folder.
FindBugs is an open source static code analyser created by Bill Pugh and David Hovemeyer which detects possible bugs in Java programs. The generated code conforms to the default set of FindBugs rules. The Gradle build script invokes the FindBugs rules when building the WAR file. If any source code violates a FindBugs rule then the build will fail.
You can run this task manually by executing this command:
// if running from a Mac or a linux distribution
./gradlew findbugsMain
// if running from Windows
gradlew.bat findbugsMainThe FindBugs report is generated in the build/reports/findbugs folder.
Code coverage is a measure used to describe the degree to which the source code of a program is executed when a particular test suite runs. The Gradle build script includes tasks to build a code coverage report.
// if running from a Mac or a linux distribution
./gradlew test jacocoTestReport
// if running from Windows
gradlew.bat test jacocoTestReportThe coverage report is generated in the build/reports/coverage folder.
- Open a Terminal from your operating system and navigate to the folder where the model project was generated. If the example server.properties values in this README were used then the model project would be generated in the /temp/wiley-app/acme-roadrunner folder.
- Execute the build using Gradle
// if running from a Mac or a linux distribution
./gradlew clean build
// if running from Windows
gradlew.bat clean build - The above command removes any past build data and rebuilds the WAR file, executing the unit tests, checkstyle, PMD, FindBugs, and code coverage utilities. With the exception of the code coverage tool, if any tool reports a failure, the build will not complete successfully.
- The WAR will be generated in the "-web" project within the build/libs folder.
The following describe how to import the View project into the WebStorm IDE by JetBrains.
- Open WebStorm and close all opened projects.
- Click Open and navigate to the folder location where the View project was generated. If the example view.properties values in this README were used then the View project would be generated in the /temp/wiley-app/wiley-view folder.
- Click the Open button.
- Open a Terminal from your operating system and navigate to the folder where the View project was generated.
- Using the Node Package Manager, install all dependencies described in the package.json file.
npm install
- Using the Node Package Manager, update all dependencies to the latest version.
npm update --save
- Install the CLI tool for Angular described at https://github.com/angular/angular-cli
npm install -g @angular/cli
- From the terminal, execute the production build to build the distribution.
ng build --env=prod
This will create a dist folder at the root of the project containing the production deployment artifacts.
- From the terminal, execute the local server to run the application locally in the browser.
ng serve
- Start your local Tomcat server from within your Intellij or Eclipse IDE (as described earlier in this README).
- Open a browser and navigate to ( http://localhost:4200 ) to login into the application.
- From the login page, enter [email protected] as the email address, DietCoke1 as the password, and click Login.
- You are now logged in as the Admin user. Click the Admin Admin menu choice and choose User Profile.
- Change the first and last names to your name and change the email address to your email address. Click Save.
- Click your name on the menu and choose User Administration. This screen allows you to search, add, and change user profiles.
- Click your name on the menu and choose Change Password. This screen allows you to change your current password.
- Click your name on the menu and choose Logout. You are logged out and taken back to the login page. You will need to login using your email address that you changed in the above instructions.
Congratulations! You now have a working application that you can build upon.
If the Big Code Bang project has helped you with your project then consider making a donation on PayPal. Your donation keeps me moving to enhance this project and build more open source projects like the Big Code Bang.
If you need help with your project, contact me on LinkedIn.
Thank you and good luck with your project!
Doug Estep