Home

Welcome to the hng_boilerplate_python_fastapi_web wiki!

General Overview

This documentation serves as a detailed guide for deploying our application using GitHub Actions. It encompasses the setup of the remote server, installation of prerequisites, and deployment processes for various environments (development, staging, and production). Additionally, it leverages Continuous Integration and Continuous Deployment (CI/CD) principles to establish a streamlined and dependable deployment pipeline.

Application Overview

Our FastAPI-based authentication system provides a robust and secure foundation for managing a SaaS application. Our platform includes features such as user authentication, organization management, payments, messaging, and various user-centric functionalities.

Technology Stack

• Backend: FastAPI
• Database: PostgreSQL

Scope

This guide covers the following aspects:

• Setting up the remote server and installing prerequisites
• Configuring the deployment of the application using Systemd
• Configuring Nginx and SSL certificates
• Implementing CI/CD principles using GitHub Actions to deploy to development, staging, and production environments
• Integrating messaging queues for service communication

Objective

The primary objectives of this guide include:

• Ensuring a seamless and reliable deployment process for our application, leveraging the power of GitHub Actions and CI/CD principles.
• Automating build, test, and deployment processes for the application
• Integrating a messaging queue to enable communication between services
• Achieving 99% uptime and ensure projects are accessible via domain names