Projects

[Vprofile] On premises Web-application

README File

1. Project Overview:

For this project, I wanted to build a multi-tier web application, by deploying each service in a single VM, resulting in decoupled applications. This is good because if a service goes down, the other ones aren’t affected.

For deployment, I used vagrant for automating the process using Infrastructure as Code (IAC), which makes it faster, more reliable, repeatable, and easier to debug also.

2. Services Used:

• - NGINX (load balancer)
• - Apache Tomcat (Application)
• - RabbitMQ (messaging)
• - Memcached (cache)
• - MariaDB (database)

3. Usage Guidelines:

• Instructions on how to run or deploy the project.
• Explanation of any command-line interfaces or parameters.
• Examples of common usage scenarios.

4. Project Structure:

• Overview of the project directory structure.
• Explanation of the purpose of each directory or important files.

5. Dependencies:

The applications dependencies were all received from the developers from this repository:
https://github.com/hkhcoder/vprofile-project

6. Configuration:

• Details on any configuration files and their purpose.
• How to customize configuration settings for different environments.

7. Testing:

• How to run tests and ensure code quality.
• Information on test coverage and test environments.

8. Deployment:

• Instructions for deploying the project to production or staging environments.
• Any special considerations or best practices for deployment.

9. Troubleshooting:

• Common issues and their solutions.
• How to get help or support (e.g., links to documentation, community forums).

10. License:

• Details about the project's license (e.g., MIT, Apache 2.0).
• Any restrictions or permissions associated with the license.

11. Contact Information:

• GitHub Repo: https://github.com/hkhcoder/vprofile-project
• How to reach out to the project maintainers or contributors (e.g., email addresses, Slack channels).
• Links to project documentation or support resources.