Skip to content

A DevOps-ready Spring MVC application for managing user profiles, integrating Jenkins, Ansible, Vagrant, and ElasticSearch. Forked from vprofile-project and customized for UI enhancements and secure deployment workflows.

Notifications You must be signed in to change notification settings

Lintshiwe/Xcod

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


# πŸš€ Xcod: DevOps-Ready Spring MVC Application

A secure, scalable user profile management system built on Spring MVC and customized for modern DevOps workflows. Forked from `vprofile-project`, this version integrates Jenkins, Ansible, Vagrant, and ElasticSearchβ€”optimized for UI enhancements and deployment automation.

---

## πŸ› οΈ Prerequisites

To run Xcod locally, ensure the following are installed:

- **JDK 21**
- **Maven 3.9**
- **MySQL 8**

---

## βš™οΈ Technologies Used

| Backend        | Frontend     | DevOps & Infra       | Messaging & Caching |
|----------------|--------------|----------------------|----------------------|
| Spring MVC     | JSP          | Jenkins              | RabbitMQ             |
| Spring Security| CSS/SCSS     | Ansible              | Memcached            |
| Spring Data JPA|              | Vagrant              |                      |
| Maven          |              | ElasticSearch        |                      |
| Tomcat         |              |                      |                      |

---

## 🧩 Project Structure

Xcod/ β”œβ”€β”€ src/ β”‚ β”œβ”€β”€ main/ β”‚ β”‚ β”œβ”€β”€ java/ # Controllers, Services, Models β”‚ β”‚ β”œβ”€β”€ resources/ β”‚ β”‚ β”‚ └── db_backup.sql # MySQL dump file β”‚ └── test/ # Unit & Integration Tests β”œβ”€β”€ Jenkinsfile # CI/CD pipeline β”œβ”€β”€ Vagrantfile # VM provisioning β”œβ”€β”€ ansible/ # Configuration management └── README.md


---

## πŸ—„οΈ Database Setup

Import the provided MySQL dump to initialize the database:

```bash
mysql -u <user_name> -p accounts < src/main/resources/db_backup.sql

🚧 Deployment Workflow

This project supports automated provisioning and deployment:

  1. Vagrant spins up the VM.
  2. Ansible configures the environment.
  3. Jenkins handles CI/CD.
  4. ElasticSearch powers search capabilities.

🌐 Live Demo & Screenshots

Coming soon: UI screenshots and hosted demo link.


πŸ“¦ Releases

  • v3.5.3 – UI Overhaul & DevOps Integration

🀝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you’d like to change.


πŸ“£ Author

Lintshiwe Pontsho Ntoampi
Third-year Computer Science student @ TUT
DevOps | Ethical Hacking | Campus Leadership
πŸ“« LinkedIn | GitHub


πŸ“œ License

This project is licensed under the MIT License.

MIT License

Copyright (c) 2025 Lintshiwe Pontsho Ntoampi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---

About

A DevOps-ready Spring MVC application for managing user profiles, integrating Jenkins, Ansible, Vagrant, and ElasticSearch. Forked from vprofile-project and customized for UI enhancements and secure deployment workflows.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 39.8%
  • Java 27.2%
  • SCSS 14.8%
  • Less 14.6%
  • Shell 3.0%
  • JavaScript 0.3%
  • Jinja 0.3%