Codebase
Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.
Getting Started Commands
Project Structure
Below is a short description of the key directories of the project to aid you when understanding where key files are located.
.github/ - This directory contains GitHub-specific configuration files and workflows for the project.
.github/workflows/ - This directory contains YAML files defining continuous integration and deployment workflows for GitHub Actions.
ansible/ - Ansible is an open-source configuration management and automation tool. This directory contains Ansible playbooks and roles for managing and configuring the project.
ansible/roles/ - This directory contains Ansible roles, which are reusable collections of tasks and configurations for managing specific aspects of a system.
ansible/roles/network/ - This role manages network configurations.
ansible/roles/screenly/ - This role is specific to the Screenly project and likely contains configurations and tasks related to it.
ansible/roles/splashscreen/ - This role manages the configuration of a splash screen.
ansible/roles/system/ - This role manages system-level configurations.
anthias_app/ - This directory contains the main application codebase for the project, likely written in Django.
anthias_app/migrations/ - This directory contains database migration files for the Django application.
anthias_django/ - This directory may contain additional Django-specific configuration files and code.
api/ - This directory contains the API codebase for the project.
api/migrations/ - This directory contains database migration files for the API.
api/serializers/ - This directory contains Django REST Framework serializers for converting data between Python objects and JSON.
api/views/ - This directory contains Django views for handling HTTP requests and rendering responses.
bin/ - This directory contains executable scripts for the project.
docker/ - This directory contains Docker configuration files and images for the project.
docker/nginx/ - This directory contains Nginx configuration files for serving the application.
lib/ - This directory contains reusable Python modules and libraries for the project.
requirements/ - This directory contains the project's Python dependencies, listed in a requirements.txt file.
static/ - This directory contains static files, such as images, CSS, and JavaScript, that are served directly to the user by the web server.
static/coffee/ - This directory contains CoffeeScript files.
static/coffee/specs/ - This directory contains CoffeeScript test files.
static/css/ - This directory contains CSS files.
static/favicons/ - This directory contains website favicons.
static/fontawesome/ - This directory contains Font Awesome icons and styles.
static/fontawesome/css/ - This directory contains Font Awesome CSS files.
static/fontawesome/webfonts/ - This directory contains Font Awesome webfont files.
static/img/ - This directory contains images used in the project.
static/js/ - This directory contains JavaScript files.
static/sass/ - This directory contains Sass files.
static/spec/ - This directory contains test files for the static files.
static/spec/jasmine/ - This directory contains Jasmine test files.
templates/ - This directory contains HTML templates used to render dynamic content.
tests/ - This directory contains test files for the project.
tests/assets/ - This directory contains test assets, such as images and JSON files.
tests/config/ - This directory contains test configuration files.
tools/ - This directory contains tools and scripts used to develop and maintain the project.
tools/image_builder/ - This tool likely builds and optimizes images for the project.
website/ - This directory contains the website codebase.
website/assets/ - This directory contains website assets, such as images, CSS, and JavaScript.
website/assets/images/ - This directory contains website images.
website/assets/styles/ - This directory contains website styles.
website/bin/ - This directory contains website executable scripts.
webview/ - This directory likely contains configuration files and code for a webview component.
webview/res/ - This directory contains webview resources, such as images and XML files.
webview/src/ - This directory contains webview source code.
Entrypoints
Below are files we identified as entrypoints for to the codebase. This is where the application starts and a good place to start when learning.
host_agent.py - Path: host_agent.py
main.js - Path: /static/js/main.js
manage.py - Path: manage.py
run_gunicorn.py - Path: run_gunicorn.py
send_zmq_message.py - Path: send_zmq_message.py
tools/migrate-assets-to-screenly.py - Path: tools/migrate-assets-to-screenly.py
