WeeklyReport

Overview

The product being analyzed is a demo that simplifies the deployment process using Docker Compose to easily start the application with one command. It includes an entrypoint.sh script that waits for the PostgreSQL database to start, checks for tables, initializes them if necessary, and then launches the app using Gunicorn on port 8000. The updated version V0.2 includes a guide for configuring the database and the config.py file with settings for departments, email notifications, user roles, and administrators.

Features

• Simplified Deployment: One-command startup using Docker Compose
• Entrypoint Script: Waits for PostgreSQL, initializes tables, and launches the app with Gunicorn
• Configurable Database: Supports SQLite or PostgreSQL with configurable URI parameters
• User Roles: Different user roles like EMPLOYEE, MANAGER, HR, and ADMINISTRATOR with varying permissions
• Quit Feature: Ability to mark employees as quit, preventing login

Installation

1. Clone the repository and navigate to the project directory.
2. Set up the PostgreSQL container by changing to the postgres directory, pulling the image, and starting the container.
3. Update the config.py file with the necessary settings for departments, email credentials, and user roles.
4. Run the app with Docker Compose using the command: docker-compose up.

Summary

The analyzed demo provides a convenient way to deploy the application with Docker Compose, simplifying the process of starting the app. It offers features like a configurable database, user roles, and an entrypoint script for initializing tables and launching the app. The installation guide outlines the steps to set up the environment and run the application successfully.