Automates — GitHub to Post Generator

---

Table of Contents

• Overview
• Features, Screenshots, & GIFS
• Repository Structure
• Demo Workflow
• Technologies

---

Overview

Automates is a web application that helps developers turn their GitHub projects into professional posts effortlessly. By linking GitHub accounts and selecting post preferences, users can generate AI-powered content tailored for specific audiences — such as hiring managers, investors, or peers. This application was developed as part of a senior design group project. It is in its MVP form and as such all functionality is not fully implemented.

Try it here: https://cjr03.github.io/GitHubPoster-AI/Frontend/Homepage/index.html

Note: This is a GitHub pages deployment of static HTML/CSS/JS files. Backend Django server is not running so API calls to OpenAI and GitHub will not work and data is instead mocked. Deployment serves to showcase frontend design and app flow.

Key highlights:

• Seamless GitHub repository and OpenAI integration
• Customizable post style, tone, and audience
• Copy-ready posts to save time and effort

Goal: Minimize post-generation time while providing professional-quality content.

---

Features, Screenshots, & GIFS

1. Customizable Parameters

• Users can add an optional description
• Style: Professional, Academic, Casual, or Other
• Audience: Employers, Classmates, Coworkers, or Other
• Tone: Formal, Friendly, Casual, or Other
• Users can review and edit generated posts

2. Text Generation

• Input from GitHub projects and user preference
• Submit to AI for automatic post creation
• Faster than manually writing a post

3. User Accounts

• Login, Logout, Sign Up, and Account management supported
• Authenticated and stored in SQLite database

Login Screen	Sign Up Screen	Account Management

Home Page

---

Repository Structure

Backend

backend/
├── automates/
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── automates_app/
    ├── chatgpt_api.py       # AI text generation
    ├── models.py            # Database models
    ├── views.py             # Request handlers
    ├── urls.py              # App routing
    ├── static/              # Backend static files
    ├── templates/           # Optional templates
    └── migrations/

• Handles GitHub and OpenAI integration
• AI text generation logic in chatgpt_api.py
• Modular URL routing and request handling

Frontend

Frontend/
├── Homepage/
├── Sign-Up/
├── Sign-In/
├── Accounts/
└── RepositoryList/

• Each folder has index.html, scripts/main.js, styles/styles.css
• Modular JS/CSS for maintainability

---

Demo Workflow

1. Sign Up / Sign In
2. Connect GitHub Account
3. Generate Post

• Select project
• Choose style, tone, audience, and optional description
• Submit and review AI-generated post
• Copy post

---

Technologies

• Backend: Python, Django, SQLite
• Frontend: HTML, CSS, JavaScript
• APIs: GitHub API, OpenAI API