You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
zanninso 2b01036410
docs: addes subject and audit for the travel-plan project (#2282)
11 months ago
..
audit docs: addes subject and audit for the travel-plan project (#2282) 11 months ago
README.md docs: addes subject and audit for the travel-plan project (#2282) 11 months ago

README.md

Travel-Plan

Objectives

The primary goal of this project is to construct a robust and scalable environment for the Travel Management System and to develop a comprehensive Admin Dashboard that serves as the control center for travel management operations.

Instructions

This is the first part of the last project and for this part, the students will be asked to build the working environment and implement the admin part to ease the last part of the project.

1. Environment Configuration

Configure a Microservices Architecture:
  • Follow industry best practices for scalability and high availability.
  • Implement multiple replicas of each microservice for load balancing and failover mechanisms.
Database Installation and Configuration:
  • Set up PostgreSQL and Neo4j databases.
  • Ensure databases are containerized to facilitate scalability and replication.
Continuous Integration/Continuous Delivery (CI/CD) Pipeline:
  • Employ Jenkins for CI/CD and unit testing.
  • Employ SonarQube to automate code quality checks
Use of Docker and Ansible:
  • Docker to support automated provisioning and deployment of microservices.
  • Ansible for creating playbooks to deploy all system elements consistently and in a scalable way.
Logging
  • Implement some sort of logging system to be able to track and trace requests across multiple services.
Outcome:
  • Achieve an automated, scalable infrastructure.
  • Prepare the groundwork for Admin Dashboard development and additional features of the Travel Management System.

2. Development and Design

  • Craft an Admin Dashboard enabling administrators to oversee users, travels, and payment gateways.
  • The admin should be able to add, edit or delete any user, travel, payment method and all the related parts correctly (think about database cascading update and delete).
  • Ensure each travel entry includes a destination or multiple destinations, dates, duration, activities, accommodation, and transportation details.
  • For the payment methods you can search about it to know what you need to do to support at least Stripe and PayPal.
  • Develop an authentication and authorization service to safeguard access and operations to the Admin Dashboard.
  • Design a responsive and intuitive UI for the Admin Dashboard that shows well in different screen sizes, ensuring browser compatibility at least for Mozilla and Chrome.
  • Utilize any beneficial packages to enhance development efficiency, with the expectation to justify package selections during project reviews.
  • Every feature should have its unit tests to ensure the new modifications don't break the code.

3. Best Practices & Ecosystem Familiarity

  • Adopt a collaborative development workflow using pull requests (PRs) for introducing changes and features.
  • Perform thorough code reviews on each PR to maintain code integrity, security adherence, and best practice compliance.
  • Integrate a CI/CD pipeline via Jenkins for seamless build, test, and deployment workflows of PRs.
  • Ensure all PRs undergo a rigorous review process, securing approval before merging into the main codebase.

4. Security Measures

  • Implement SSL/TLS encryption for all data in transit.
  • Ensure databases and services are accessible only within the internal network or via secure, authenticated endpoints.
  • Use secret management tools like HashiCorp Vault to handle sensitive information like API keys and database credentials.
  • Apply the principle of least privilege across all levels of the system, particularly in role-based access controls within the Admin Dashboard.
  • Regularly update all components to patch known vulnerabilities and ensure compliance with security best practices.

Bonus

  • Compose clear and detailed documentation for the application and database schema.
  • Incorporate Kubernetes alongside Ansible to enhance service management, orchestration, and load-balancing capabilities.
  • Implement integration and/or E2E tests
  • Any other bonus that adds real value to the project.