Prepix 🔭

Pretty Pics Portal. A full-stack application for managing and displaying images.

Overview

Dark/Light modes

Upload/Search panels

Toasts

Expanded visualization

Tech Stack

• Frontend: React, Vite, Tailwind CSS
• Backend: Python, FastAPI, SQLAlchemy, Alembic
• Database: PostgreSQL
• Dependency Management: uv (Python), npm (Node.js)
• Testing: Vitest (frontend), Pytest (backend)
• Containerization: Docker, Docker Compose
• Web Server: Nginx

Getting Started

Prerequisites

• Docker and Docker Compose
• Make
• Python 3.12+
• Node.js and npm
• uv (for Python dependency management)

Installation

1. Clone the repository:

   git clone <repository-url>
   cd Prepix

2. Set up environment variables: Create a .env file in the backend/ directory by copying the example file:

   cp backend/.env.example backend/.env

   Update the backend/.env file with your database credentials and other settings.

   Note: This .env file is essential for running the application with Docker Compose. The docker-compose.yml file is configured to load this file and provide the necessary environment variables (like database credentials) to the application containers.

3. Install dependencies (for local development): Use the make command to install all backend and frontend dependencies.

   make install

   Note: This step is recommended for setting up a complete development environment. Installing dependencies locally is crucial for IDE support (e.g., autocompletion, linting) and for running tests or other commands directly on your host machine. If you only intend to run the application via docker-compose up, this step is not strictly required, as dependencies are managed within the Docker containers.

Running the Application

To run the application in a containerized environment, use Docker Compose:

docker-compose up --build

The application will be available at http://localhost:80.

Testing

This project includes a comprehensive test suite for both the frontend and backend.

Run all tests

To run all tests for both the frontend and backend, use the following command:

make test

Backend Tests

To run only the backend tests:

make test-backend

Frontend Tests

To run only the frontend tests:

make test-frontend

Test Coverage

To generate test coverage reports for both frontend and backend:

make coverage

Coverage reports will be generated in the frontend/coverage/ and backend/htmlcov/ directories.

Running Tests in Docker

To run the tests within a Docker container (as in a CI environment), use:

make docker-test

License

The source code of this project is distributed under the Apache 2.0 license — see LICENSE.

The EUCLID data used here for illustration purposes is subject to the CC-BY-NC-ND-4.0 license.