This is an old revision of the document!
1. Project Overview: Cotrav-Platform
This document outlines the initial setup and integration steps for the cotrav-platform using GitLab.
2. Getting Started & Repository Setup
To begin working with the project, follow these steps to link your local code to the GitLab repository:
Step 1: Open your terminal and navigate to your project folder.
Step 2: Add the remote origin and push your code using these commands:
| GIT Command cd existing_repo git remote add origin https://gitlab.com/cotrav-tech/cotrav-platform.git git branch -M main git push -uf origin main/dev/test/production |
3. Collaboration & Team Integration
To maintain a smooth workflow, the following GitLab features are enabled:
Team Access: Invite members and collaborators to the project.
Code Review: Use Merge Requests to propose changes.
Automation: Enable Auto-merge and “Automatically close issues” via merge requests.
Security: Approval rules are set up to ensure code quality before merging.
4. CI/CD, Testing & Deployment
The platform uses GitLab’s built-in CI/CD pipelines to automate testing and deployment:
Security (SAST): Automatically scans code for vulnerabilities using Static Application Security Testing.
Cloud Deployment: Supports Auto Deploy to Amazon EC2, ECS, or Kubernetes.
Environment Protection: Critical environments (like Production) are protected to prevent unauthorized changes.
1. Project Introduction
The cotrav-platform is a web-based application. This document explains how the code is managed, tested, and deployed using GitLab’s built-in CI/CD features
2. Getting Started (Setup)
To start working on this project, link your local code to the GitLab repository using these commands:
| # Navigate to your project folder cd existing_repo # Connect to the GitLab Repository git remote add origin https://gitlab.com/cotrav-tech/cotrav-platform.git # Set the main branch and push code git branch -M main git push -uf origin main |
3. Repository File Structure
The project is organized as follows to support automation:
src/: Contains the main application source code.
.gitlab-ci.yml: The main configuration file for automation (Build, Test, Deploy).
.gitignore: Tells Git to ignore unnecessary files (like node_modules or local logs).
Dockerfile: Used to package the application for cloud deployment.
README.md: This guide for the team.
4. Development Workflow
We follow a standard Git workflow to ensure code quality:
Branching: Developers work on the dev branch.
Merging: Once the code is ready, we perform a Merge Request (MR) from dev to main.
Review: Team members approve the code before it is merged into the Test & production line.
Latest Update:
6. Security and Environments
Protected Environments: The main branch and Production environments are protected. Only authorized users can deploy.
Auto-Merge: Enabled to speed up the delivery of small fixes.