Prototype

This is a quick-start template for setting up a Django project with OpenAI integration. The project is containerized with Docker, allowing for easy setup and consistent deployment.

Check out the report on creating with Prototype on dev.to or YouTube.

Shoutouts

Prototype was featured as a top project on Product Hunt.

Requirements

Before starting, ensure you have:

• Docker and Docker Compose installed (latest versions recommended).

Quick Start

Step 1: Clone the repository

git clone https://github.com/vorniches/prototype your_app_name
cd your_app_name

Step 2: Start the project

Run the following command to set up the environment:

./setup.sh

This will:

1. Create a Django project (if not already present).
2. Move the openai_helper.py to the appropriate directory.
3. Build and start the Docker containers.

Access the Application

The Django development server will be available at:

• http://localhost:9009

Configuration

Environment Variables

1. Copy the example.env file to .env:

   cp example.env .env

2. Edit .env to include your OpenAI API key:

   OPENAI_API_KEY=<your_openai_api_key>

3. Ensure the environment variables are loaded into Django's settings.py.

License

This project is licensed under the MIT License. See the LICENSE file for details.