Skip to content

Quick Start Guide

This guide provides a quick overview of how to use the release strategy implemented in this repository.

Getting Started

Prerequisites

  • Git
  • kubectl
  • Helm
  • k3d (for local development)
  • ArgoCD CLI
  • GitHub CLI (gh)

Setting Up Your Environment

  1. Clone the repository: 

    git clone https://github.com/datascientest-fastapi-project-group-25/fastAPI-project-release.git
cd fastAPI-project-release

  2. Set up a local Kubernetes cluster with ArgoCD: 

    ./scripts/setup-local-k3d-argocd.sh

  3. Set up ArgoCD API key and GitHub secrets: 

    ./scripts/setup-argocd-github.sh

Development Workflow

  1. Create a feature or fix branch: 

    git checkout -b feat/your-feature-name
# or
git checkout -b fix/your-fix-name

  2. Make your changes and commit them: 

    git add .
git commit -m "Your commit message"

  3. Push your branch to GitHub: 

    git push -u origin feat/your-feature-name

  4. A PR will be automatically created, and tests will run

  5. After review and approval, merge the PR to main

Accessing Your Deployment

  1. Port-forward ArgoCD server: 

    kubectl port-forward svc/argocd-server -n argocd 8080:443

  2. Access ArgoCD UI at https://localhost:8080

  3. Username: admin

  4. Password: (retrieved during setup)

  5. View your application deployment

Additional Resources