• Overview
• Project Structure
• Getting Started
  • Prerequisites
  • Setting Up the Development Environment
• Running the Application
  • Docker Compose
• Troubleshooting
• Contributing
• License

DisplayMain is an unattended web display application designed to run on a dedicated PC and display information on a large screen. It is powered by FastAPI and can be used to showcase customized content to viewers who pass by the display.

The project has the following structure:

Ensure the following prerequisites are installed on the development machine:

• Docker: Install Docker
• Docker Compose: Install Docker Compose

1. Clone the project repository to your local machine:

   git clone <repository-url>

1. Build the Docker image for the FastAPI application:

docker-compose build

2. Start the containers:

docker-compose up

The FastAPI dev server should now be running, and you can access it by opening a web browser and navigating to http://localhost:8000. You should see the "Hello world" message.

If you encounter any issues or errors while setting up or running the application, please refer to the Troubleshooting section in the README or seek assistance from the project contributors.