Picture Perfect

About the Project

Description

Picture Perfect is an AI-powered game designed to challenge your creativity! Input any text-based prompt you can imagine and get back a realistic image. The better the prompt, the better the image! Once you have prompt engineered to your heart's content, check out the voting page where images compete for your vote. Check out the leaderboard to see how you fare in comparison to other PicPerfers!

Tech Stack

Backend

• 
• 
• 

Frontend

• 
• 
• 

Installation and Setup

1. Make sure you have Python and Node environments set up (this includes npm and pip3). The latest stable releases should be fine as of December 2023, but this project uses Node v20 and Python 3.10.

2. Installing the frontend packages. From root:

   • cd Frontend
   • npm install

3. Installing the backend packages. From root:

   • cd Backend
   • pip3 install -r requirements.txt

4. Currently, the frontend is hosted locally. Run it with the command npm run dev in the Frontend folder.

UI Prototype

Code Coverage

As of Dec. 7 @ 8 PM PST

Code Style Guide

To maintain code quality and ensure consistency throughout our codebase, we have adopted specific style guides for our backend and frontend code. Contributors are expected to follow these style guidelines when submitting code to the project.

Backend (Python)

For our backend code, we follow the pycodestyle conventions, specifically version 2.11.1. This tool checks your Python code against some of the style conventions in PEP 8.

To install pycodestyle, run the following command:

pip install pycodestyle==2.11.1

Before submitting a pull request, please check your code for style violations by running:

pycodestyle your_script.py

Replace your_script.py with the path to the file you want to check. Address any style warnings/errors before submitting your code.

Frontend (Next.js)

For the frontend, we use Next.js framework and enforce code styles and conventions using ESLint and Prettier. Ensure you have the latest versions of both installed.