Skip to content

CK3thou/salarytransparency

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Running the Project with Docker

This project provides a Dockerfile and a Docker Compose setup for running a Python 3.11 application in a containerized environment. The setup uses a multi-stage build for efficient image size and security, and installs dependencies from requirements.txt into a virtual environment.

Project-Specific Requirements

  • Python Version: 3.11 (as specified by the python:3.11-slim base image)
  • Dependencies: All Python dependencies must be listed in requirements.txt (if present). These are installed into a virtual environment at /app/.venv.
  • Entrypoint: The default command runs python main.py. Update the CMD in the Dockerfile if your main entrypoint differs.

Environment Variables

  • No required environment variables are set by default. If your application needs environment variables, add them to a .env file and uncomment the env_file line in docker-compose.yml.

Build and Run Instructions

  1. Build and start the application:

    docker compose up --build

    This will build the image and start the python-app service.

  2. Customizing the Entrypoint: If your application entrypoint is not main.py, update the CMD in the Dockerfile or override the command in docker-compose.yml.

Special Configuration

  • The container runs as a non-root user (appuser) for improved security.
  • If your application requires external services (e.g., Postgres, Redis), uncomment and configure the relevant blocks in docker-compose.yml.
  • If you need to expose ports (e.g., for a web server), uncomment and adjust the ports section in docker-compose.yml.

Ports

  • No ports are exposed by default.
    • If your application listens on a port (e.g., 8000 or 5000), uncomment and set the appropriate ports mapping in docker-compose.yml.

Keep this section up to date if you change the Docker setup or add new services.

About

salarytransparency

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors