TL;DR Trailers

A university project developed by Serafin Lichtenhahn

Introduction

This application is built using Next.js and managed with pnpm. TL;DR Trailers leverages a MySQL database, OpenAI and Replicate APIs, AWS services, and features a user interface crafted with shadcn/ui and Tailwind CSS.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js
• pnpm package manager
• MySQL database access
• API keys for OpenAI and Replicate
• AWS credentials

Installation

To set up the project:

1. Clone the repository:

   git clone https://git.arts.ac.uk/serafin/tldr-trailers

2. Navigate to the project's directory:

   cd tldr-trailers

3. Install dependencies with pnpm:

   pnpm install

Environment Variables

Create a .env.local file at the root of the project with the following structure:

DATABASE_URL="<mysql-database-url>"
OPENAI_API_KEY="<openai-api-key>"
REPLICATE_API_TOKEN="<replicate-api-token>"

BASE_URL="<base-url>"

AWS_ACCESS_KEY_ID="<aws-access-key-id>"
AWS_SECRET_ACCESS_KEY="<aws-secret-access-key>"
AWS_REGION="<aws-region>"
AWS_BUCKET="<aws-bucket-name>"

Replace the placeholder values with your actual credentials.

Database Configuration

This project utilizes a MySQL database. Ensure your database is operational and the DATABASE_URL in your .env.local file points to your MySQL instance.

UI Components

TL;DR Trailers' interface is built using shadcn/ui and styled with Tailwind CSS. For guidance on these tools, refer to their documentation:

• shadcn/ui: GitHub - shadcn/ui
• Tailwind CSS: Tailwind CSS Documentation

Running the Application

Launch the application locally with:

pnpm run dev

The app will typically run on http://localhost:3000 unless a different port is configured.

Contributions

Contributions are encouraged. Please adhere to the project's code of conduct and submit pull requests for proposed changes.

License

TL;DR Trailers is under the MIT License.