Feature/raza

README(2).md

@@ -0,0 +1,115 @@
+# ENSF 400 - Winter 2025 - Course Project
+
+## Project Overview
+
+In this project, you will work based on a software project by incorporating/extending a complete CI/CD (Continuous Integration/Continuous Deployment) pipeline. This is based on an open-source sample application: https://github.com/7ep/demo
+
+This project can also be any application that requires the project of build, test, and deployment.
+You will leverage GitHub for source control, Docker for containerizing your application, and a CI/CD tool (Jenkins) to automate the build, testing, and verification process. The goal is to validate every code change automatically through container builds, unit tests, code quality checks, and end-to-end functional tests.
+
+
+## Project Requirements
+
+By the end of this project, your group must deliver the following:
+
+1.	Manage your project on GitHub and follow proper Git workflows (branching, pull requests, code reviews). Document the process of how you use Git workflows to collaborate with your team members.
+
+1.	Containerize your application for builds and deployments. Upload and download your container images to a public or private image repository (e.g., Docker Hub or GitHub Container Registry). Ensure a container image is built with unique build tag(s) matching the triggering commit from any branch.
+
+1.	Set up an automated CI/CD with Jenkins in a Codespace environment. Configure the pipeline to trigger upon pull requests merging changes into the main branch.
+
+1.	Document the CI/CD process and provide clear instructions on replicating your environment. Submit a video demo at the end of the project.
+
+### Existing Pipelines
+You will also demonstrate the delivery of the following process and artifacts that come with the project.
+
+1.	Run static analysis quality-gating using SonarQube
+1.	Performance testing with Jmeter
+1.	Security analysis with OWASP's "DependencyCheck"
+1.	Build Javadocs
+
+
+## Evaluation Criteria
+
+Your project will be assessed on the following criteria:
+
+### GitHub Repository & Git Workflow (15%)
+1.	Project on GitHub in a public repository with all team members participating in the development and maintenance of the project (5%).
+1.	Demonstrate the process practicing Git workflows (branching, pull requests, code reviews) (10%).
+
+### Containerization (20%)
+1.	Dockerfile to containerize the project (5%).
+1.	Use of container image repository to upload and download images (5%).
+1.	Effective tagging mechanism for each building matching the commits/branches/pull requests (10%).
+
+### CI/CD Pipeline Automation (40%)
+1.	Jenkins integration with GitHub in Codespace (10%).
+1.	Triggering automated checks upon pull request to the main branch (10%).
+1.	Deployment process to automatically deploy the application in the Codespace environment upon a build (10%).
+1.	Be able to run items 5-8 in **Existing Pipelines** (10%).
+
+### Testing & Code Quality (10%)
+1.	Generate test coverage reports upon each automated build (5%).
+1.	Generate code quality report using SonarQube reports upon each automated build (5%).
+
+### Documentation & Demo (15%)
+1.	Clarity and completeness of README and other documentation. The documentation must demonstrate the team’s collaboration process (5%).
+1.	Demonstration video with a length not exceeding 10 minutes, showing a clear understanding of the pipeline and its benefits. The documentation must demonstrate the team’s collaboration process (10%).
+
+_______________________________________________________________________________________________________________________________________________________________________________________________________________
+
+# Organization of our ENSF 400 CI/CD Project  
+
+## Team Members  
+- Josral Frederick UCID: 30195360
+- Muhammad Aun Raza My UCID: 30172183
+- Natnael Tekli UCID: 30171167
+- Jaden Chow UCID: 30173676
+
+
+## Project Description  
+The main objective in this project is to create software that incorporates/extends a complete CI/CD 
+(Continuous Integration/Continuous Deployment) pipeline. 
+
+## Git Workflow  
+- **Branching Strategy**: 
+We will use a Feature Branching Strategy, where each new feature or bug fix is developed in its own branch. 
+- The main branch will be called ‘main'
+- Development branches will follow the naming convention ‘feature/[feature-name]’ for features
+- Finally ‘bugfix/[bug-name]’ for bug fixes.  
+
+- **Pull Requests**: 
+  Upon completion of a feature, developers will create a pull request (PR) from their `feature` branch
+  to the `main' branch. Each PR will contain a description of the changes made and link to any relevant issues.
+  The PR will be reviewed by at least one team member before merging.
+
+- **Code Reviews**:
+  The code review will take place within the Github interface. Each PR will be reviewed by atleast one team member before being merged to the main branch. The reviewer will
+  make sure the PR is in accordance with the project requirements and necessary discussions will take place within the request.
+
+## Containerization  
+- **Dockerfile**:
+  A Dockerfile is a set of instructions to automate the creation of a Docker Image. The Dockerfile helps containerize the application, ensuring it is built, tested and deployed.
+  This is done by packaging the application into a container, works with Kubernetes and enables automation in the CI/CD pipeline.
+
+- **Image Repository**: Instructions for pushing/pulling images and how tagging works.  
+Container images will be pushed to **Docker Hub**. To push an image, use the following command:  
+  ```bash
+  docker push <your-dockerhub-NatnaelTekli>/task-manager-app:<tag>   
+
+## CI/CD Setup  
+- **Jenkins Configuration**: Explain the integration with GitHub and how the pipeline is set up.  
+
+## Running the Project  
+Instructions for running the application locally, including prerequisites.  
+
+
+
+
+Instructions for running the application locally, including prerequisites.  
+
+## Testing  
+- **Testing Framework**: Briefly describe tools used for testing.  
+  We have access to automated testing tools integrated into the CI/CD pipeline (Jenkins), these will help with unit, integration, security, and performance
+
+- **Code Quality Reports**: Link to generated SonarQube reports.