Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit e2e81a6

Browse files
Update README.md
1 parent 2f6ac3a commit e2e81a6

File tree

1 file changed

+144
-2
lines changed

1 file changed

+144
-2
lines changed

‎README.md‎

Lines changed: 144 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,144 @@
1-
CI/CD Pipeline for Java and Node.js Applications
2-
Welcome to the CI/CD pipeline project, designed to automate the build, test, deployment, and monitoring of Java and Node.js applications using Jenkins. This project demonstrates a streamlined process for continuous integration and deployment, ensuring both Java and Node.js applications are tested, analyzed, and deployed automatically.
1+
CI/CD Pipeline for Java and Node.js Applications 🚀
2+
Welcome to the CI/CD Pipeline Project, a modern, automated solution for building, testing, and deploying Java and Node.js applications using Jenkins. This project demonstrates a seamless, fully integrated pipeline that ensures both applications are consistently deployed with top-notch code quality checks, automated testing, and efficient management.
3+
4+
🎯 Project Overview
5+
This repository consists of two Jenkins pipelines, each handling different parts of the project:
6+
7+
1️⃣ Pipeline 1 - Java Application (Maven-based)
8+
Automated Build & Test: Compiles Java code and runs unit tests.
9+
10+
Code Quality Analysis: Runs SonarQube to ensure high-quality code.
11+
12+
Artifact Deployment: Deploys to Nexus for artifact storage.
13+
14+
Application Deployment: Deploys the Java application to Tomcat.
15+
16+
Triggers Pipeline 2: On success, automatically triggers Pipeline 2 (Node.js).
17+
18+
2️⃣ Pipeline 2 - Node.js Application (npm-based)
19+
Automated Checkout: Pulls the Node.js application from GitHub.
20+
21+
Dependency Management: Installs all required dependencies using npm.
22+
23+
Unit & Jest Tests: Runs tests to ensure application integrity.
24+
25+
Code Quality Analysis: Performs SonarQube code analysis.
26+
27+
Application Deployment: Deploys the Node.js application using PM2.
28+
29+
PM2 Status Check: Verifies if the app is running successfully.
30+
31+
💡 Project Goals
32+
This project strives to achieve:
33+
34+
Automated Deployments: From build to deployment for both Java and Node.js applications.
35+
36+
Quality Assurance: SonarQube integration for automatic code quality analysis.
37+
38+
Real-time Notifications: Instant Slack notifications about the build status.
39+
40+
Efficient Management: Deploy Java apps on Tomcat and manage Node.js apps with PM2.
41+
42+
⚙️ How It Works
43+
This project leverages two pipelines to handle the automation of your applications:
44+
45+
Pipeline 1 (Java Application)
46+
Checkout: Clones the Java project from GitHub.
47+
48+
Compile & Test: Builds and tests the application using Maven.
49+
50+
SonarQube Analysis: Runs a code quality check using SonarQube.
51+
52+
Deploy to Nexus: Deploys the Java artifact to Nexus for versioning.
53+
54+
Deploy to Tomcat: Deploys the built application to the Tomcat server.
55+
56+
Trigger Pipeline 2: On success, triggers Pipeline 2 to start the Node.js pipeline.
57+
58+
Pipeline 2 (Node.js Application)
59+
Checkout: Clones the Node.js project from GitHub.
60+
61+
Install Dependencies: Uses npm to install necessary packages.
62+
63+
Unit & Jest Tests: Executes both unit and Jest tests for the application.
64+
65+
SonarQube Analysis: Runs SonarQube analysis for Node.js code quality.
66+
67+
Start Application with PM2: Deploys the Node.js app using PM2.
68+
69+
Verify Status: Uses PM2 to check the application’s running status.
70+
71+
🌟 Why This Project?
72+
This project is designed to solve several challenges in modern development workflows:
73+
74+
Automate everything: No more manual deployments. Everything, from builds to tests to deployment, is automated.
75+
76+
High-quality code: Continuous SonarQube analysis ensures that your code maintains the highest standards.
77+
78+
Real-time updates: Stay informed with Slack notifications every time a build succeeds or fails.
79+
80+
Seamless app management: Tomcat for Java and PM2 for Node.js makes managing your applications effortless.
81+
82+
🛠️ Technologies Used
83+
Jenkins: For automating the entire build, test, and deployment pipeline.
84+
85+
GitHub: Hosts the source code for both Java and Node.js applications.
86+
87+
Maven: Handles the build and deployment for the Java project.
88+
89+
SonarQube: Analyzes the code quality to maintain high standards.
90+
91+
Nexus: Stores Java artifacts for deployment and versioning.
92+
93+
Tomcat: Hosts and runs the Java application.
94+
95+
PM2: Manages and runs the Node.js application efficiently.
96+
97+
Slack: Sends real-time notifications about build status.
98+
99+
🚀 How to Set Up and Run
100+
1️⃣ Install Jenkins and Required Plugins
101+
Install the following Jenkins plugins:
102+
103+
NodeJS plugin
104+
105+
SonarQube plugin
106+
107+
Slack Notification plugin
108+
109+
JUnit plugin
110+
111+
2️⃣ Configure Jenkins Tools
112+
Go to Jenkins Global Configuration and add Node.js and Maven.
113+
114+
3️⃣ Set Up GitHub Repositories
115+
Ensure your Java and Node.js projects are hosted on GitHub and have webhooks set up to trigger Jenkins jobs.
116+
117+
4️⃣ Create the Pipelines in Jenkins
118+
Pipeline 1 (Java): Create a Jenkins pipeline that handles the Java application’s build, test, SonarQube analysis, and deployment.
119+
120+
Pipeline 2 (Node.js): Create a Jenkins pipeline for Node.js that manages checkout, testing, SonarQube analysis, and PM2 deployment.
121+
122+
5️⃣ Integrate SonarQube
123+
Set up SonarQube analysis for both projects to maintain code quality.
124+
125+
6️⃣ Add Slack Integration
126+
Set up Slack webhooks in Jenkins to get instant notifications of build results.
127+
128+
7️⃣ Trigger Pipelines
129+
Pipeline 1 triggers Pipeline 2 automatically upon successful completion.
130+
131+
📝 Challenges Faced
132+
Managing Two Different Tech Stacks: Integrating both Java (Maven) and Node.js (npm) pipelines required handling separate build tools and environments.
133+
134+
SonarQube Integration: Ensuring that SonarQube correctly analyzes both Java and Node.js code with the same configurations.
135+
136+
Deployment Management: Deploying the Java app to Tomcat and the Node.js app using PM2 required careful configuration of both servers.
137+
138+
Monitoring and Notifications: Configuring Slack notifications and PM2 status checks for real-time feedback on app performance.
139+
140+
🎉 Conclusion
141+
This CI/CD pipeline provides a comprehensive solution for automating the deployment and management of Java and Node.js applications. By integrating tools like Jenkins, SonarQube, PM2, and Slack, this project ensures that both your applications are constantly tested, deployed, and monitored, giving you peace of mind and improved productivity.
142+
143+
🔧 Get Started
144+
Clone this repository and adapt it to your own needs. Customize the pipeline scripts for your specific Java and Node.js projects, and you'll have a robust CI/CD solution in no time! 🎉

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /