Skip to main content

​
Overview

OnlyAutomator is a comprehensive suite of tools designed for OnlyFans creators to optimize their presence, analyze performance metrics, and maximize revenue.

Web Application

Dashboard & analytics interface built with Next.js

Chrome Extension

Data collector & OnlyFans integration

Microservice

Backend processor & data scraper

Database

Supabase schema and data structure

​
Getting Started

Follow these steps to set up the entire OnlyAutomator ecosystem for development.

​
Prerequisites

1

Install Node.js

Install Node.js 18.x or higher from nodejs.org
2

Install Package Manager

We recommend using pnpm for the web application and npm for the extension and microservice
npm install -g pnpm
3

Set Up Supabase

Create a Supabase account and project for your database

​
Clone Repositories

git clone https://github.com/onlyautomator/only-automator-webapp.git
cd only-automator-webapp
pnpm install
cp .env.local.example .env.local
# Edit .env.local with your Supabase credentials
pnpm dev
# The app will be available at http://localhost:3000
The web application requires a connection to either a local or remote instance of the microservice.
git clone https://github.com/onlyautomator/only-automator-plugin-v2.git
cd only-automator-plugin-v2
npm install
cp .env.example .env
# Edit .env with your configuration
npm run dev
Once built, load the extension in Chrome:
  1. Open Chrome and go to chrome://extensions/
  2. Enable “Developer mode”
  3. Click “Load unpacked” and select the dist folder
git clone https://github.com/onlyautomator/only-automator-microservice.git
cd only-automator-microservice
npm install
cp .env.example .env
# Edit .env with your configuration
npm run build
npm start
# The service will run on http://localhost:3001
For production, use PM2 to manage the process:
npm install -g pm2
pm2 start dist/index.js --name onlyautomator-microservice

git clone https://github.com/onlyautomator/only-automator-microservice-contabo.git
cd only-automator-microservice-contabo
npm install
cp .env.example .env
# Edit .env with your configuration
npm run build
npm start
This version is optimized for deployment on Contabo VPS servers.
git clone https://github.com/onlyautomator/only-automator-plugin.git
cd only-automator-plugin
npm install
npm run build
This is the legacy version of the extension and is no longer actively maintained. We recommend using the v2 version for all new development.

​
Development Workflow

1

Set up the microservice

Start by setting up the microservice as it’s required by both the web application and extension
2

Configure the database

Set up your Supabase database using the database schema
3

Run the web application

Start the web application and ensure it can connect to the microservice
4

Set up the Chrome extension

Install the Chrome extension and connect it to your development environment

Architecture

Understand how all components work together

API Reference

Detailed API documentation for all endpoints

Development Guide

In-depth development guidelines and best practices

Database Schema

Explore the database structure and relations

Email System

Learn about the email marketing automation

Contributing

Guidelines for contributing to the project

​
Environment Variables

Each repository has specific environment variables that need to be configured. Here’s a quick summary: 
# .env.local example
NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-supabase-anon-key
MICROSERVICE_URL=http://localhost:3001
RESEND_API_KEY=your-resend-api-key

​
Common Issues

Make sure your CORS configuration in the microservice allows connections from your extension.In the microservice .env:
ALLOWED_ORIGINS=chrome-extension://your-extension-id,http://localhost:3000
Verify your Supabase URL and anon key in the .env.local file. Also ensure that your IP is allowed in Supabase’s API settings.
The microservice requires Chrome/Chromium to be installed for Puppeteer. On Linux servers, you may need to install additional dependencies:
sudo apt-get update
sudo apt-get install -y gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget

​
Next Steps

Now that you have set up your development environment, you can explore more about the OnlyAutomator ecosystem:

Extension Development

Learn how to develop and customize the Chrome extension

Web App Customization

Customize the web application UI and functionality

API Integration

Integrate with the OnlyAutomator API