Skip to content

iabhee/cloud-resume-api

Repository files navigation

Cloud Resume API

Infrastructure Code

Overview

This project is a cloud-based resume application that allows users to showcase their resume using a serverless API hosted on Azure. The back-end is powered by an nodeJS API that provides data to render the resume dynamically. This project demonstrates cloud architecture best practices and integrates multiple cloud services.

Code Documentation

For detailed documentation on the codebase, including architecture, setup instructions, and usage, please refer to our internal code documentation. This documentation covers:

  • Project structure: Overview of the main components of the project.
  • Setup & Installation: Instructions for setting up the development environment.
  • Usage: How to use the application and its components.
  • Testing: Guidelines for running unit tests, integration tests, and performance tests.

Infrastructure Documentation

For documentation on the infrastructure, deployment processes, and configuration details, refer to our internal infrastructure documentation. This includes:

  • Infrastructure as Code: Details about the infrastructure setup, including tools like Terraform, Kubernetes, and any other provisioning methods used.
  • Deployment Pipeline: Overview of the CI/CD pipeline used for deploying the application to various environments.
  • Environment Variables: List of environment variables and configuration settings for different stages (e.g., dev, staging, production).
  • Scaling & Monitoring: Information on scaling the application, as well as monitoring and logging setup for production environments.

Getting Started

To get started with this project, follow the instructions below:

Prerequisites

  • [List any prerequisites such as tools, libraries, or environments]

Setup

  1. Clone the repository:
    git clone <repository-url>