copywriterproai backend

CopywriterProAI: Die weltweit erste Open-Source-KI-Schreibplattform für SEO und Anzeigentexte

---

Willkommen im Backend-Repository von CopywriterProAI, der weltweit ersten Open-Source-KI-Schreibplattform für SEO und Anzeigentexte. Das Backend von CopywriterProAI unterstützt die KI-Funktionen und verwaltet die Verarbeitung Ihrer Inhalte, um einen reibungslosen und effizienten Betrieb zu gewährleisten. Es ist, als ob Ihr eigener KI-Schreibassistent hinter den Kulissen arbeitet und immer bereit ist, Ihnen zu helfen.

⚡ Erste Schritte

Anforderungen

• Knoten v12.0+
• Garn
• MongoDB-Datenbank
• Docker
• Docker Compose

Abhängigkeiten installieren:

yarn

Umgebungsvariablen festlegen: Aus der Datei „.env.example“ kopieren und neue Umgebungsvariablen hinzufügen:

.env

Umgebungsvariablen

PORT=8080

# MONGODB Database configuration
MONGODB_URL=mongodb://127.0.0.1:27017/copywriterpro

# JWT secret key
JWT_SECRET=23uF$%gdfh43@kDj#6Yf8sV4kL@Z9m#N7bS^Yhd9
# Number of minutes after which an access token expires
JWT_ACCESS_EXPIRATION_MINUTES=15
# Number of days after which a refresh token expires
JWT_REFRESH_EXPIRATION_DAYS=1000

# WORD LIMIT
PACKAGES=FREEMIUM,BASIC_1MONTH,BASIC_6MONTH,STANDARD_1MONTH,STANDARD_6MONTH,PROFESSIONAL_1MONTH,PROFESSIONAL_6MONTH
INPUT_CHARACTER_RATE=1,1,1,2,2,4,4

# COPYSCAPE
COPYSCAPE_USERNAME=randomUser123
COPYSCAPE_API_KEY=randomAPIKey12345
PLAGIARISM_CHECKER_ALLOWED_PACKAGES=FREEMIUM,BASIC_1MONTH

# Google oauth2 client id
GOOGLE_OAUTH2_CLIENT_ID=352363168566-random-client-id-12345.apps.googleusercontent.com

# Google oauth2 secret id
GOOGLE_OAUTH2_SECRET_ID=randomSecretId12345

# Passport secret jwt key
PASSPORT_SECRET_JWT_KEY=randomPassportSecretKey12345

# Passport auth expires time
PASSPORT_AUTH_EXPIRES_TIME=1h

# Facebook app id
FACEBOOK_APP_ID=1234567890123456

# Facebook app secret
FACEBOOK_APP_SECRET=randomFacebookAppSecret12345

# STRIPE
STRIPE_SECRET_KEY=sk_test_randomStripeSecretKey12345
STRIPE_WEBHOOK_SECRET_KEY=whsec_randomStripeWebhookKey12345

# SMTP configuration options for the email service
SMTP_HOST=email-smtp.us-east-1.amazonaws.com
SMTP_PORT=465
SMTP_USERNAME=randomSMTPUsername12345
SMTP_PASSWORD=randomSMTPPassword12345
[email protected]

# OpenApi
OPENAI_API_KEY=sk-proj-randomOpenApiKey12345

# Web Client URL
WEB_CLIENT_URL=http://localhost:3000

# Mail token verify
MAIL_VERIFY_TOKEN_SECRET=randomMailVerifyTokenSecret12345
MAIL_VERIFY_TOKEN_EXPIRE=10m

# Cors Whitelist
CORS_WHITELIST=https://example.com,https://example2.com,http://localhost:3000,http://localhost:5000

# Sentry dns URL
SENTRY_DNS_URL=https://[email protected]/5791435

Lokal ausgeführt

yarn dev

Läuft in der Produktion

yarn start

Docker-Setup

Um die Einrichtung für Entwickler zu vereinfachen, stellen wir eine Docker-Konfiguration bereit, die es Ihnen ermöglicht, das Projekt mit einem einzigen Docker-Compose-Up-Befehl auszuführen.

Docker-Setup-Schritte

Klonen Sie das Repository:

git clone https://github.com/CopywriterPro-ai/copywriterproai-backend
cd copywriterproai-backend

Kopieren Sie die Datei .env.sample nach .env und aktualisieren Sie alle erforderlichen Konfigurationen:

cp .env.sample .env

Erstellen Sie das Projekt und führen Sie es mit Docker Compose aus:

docker-compose up --build

Greifen Sie auf die Anwendung zu:

Das Backend wird auf http://localhost:8080 ausgeführt.

Dokumentation

Um mehr über das Projekt zu erfahren und Tipps zur Verwendung von CopywriterProAI zu erhalten, schauen Sie sich unsere Dokumentation an.

Dort finden Sie Ressourcen zur Verwendung verschiedener LLM-Anbieter, Ressourcen zur Fehlerbehebung und erweiterte Konfigurationsoptionen.

? So können Sie einen Beitrag leisten

CopywriterProAI ist ein Community-Projekt und wir freuen uns über Beiträge von jedem. Egal, ob Sie Entwickler, Forscher oder einfach nur begeistert davon sind, den Bereich der Inhaltserstellung mit KI voranzutreiben, es gibt viele Möglichkeiten, sich zu engagieren:

• Codebeiträge : Helfen Sie uns, neue Funktionen zu entwickeln, die Benutzeroberfläche zu verbessern oder das Backend zu optimieren.
• Forschung und Bewertung : Tragen Sie zu unserem Verständnis von KI bei der Erstellung von Inhalten bei, beteiligen Sie sich an der Bewertung von Modellen oder schlagen Sie Verbesserungen vor.
• Feedback und Tests : Verwenden Sie CopywriterProAI, melden Sie Fehler, schlagen Sie Funktionen vor oder geben Sie Feedback zur Benutzerfreundlichkeit.

Weitere Informationen finden Sie unter CONTRIBUTING.md.

? Treten Sie unserer Community bei

Egal, ob Sie Entwickler, Forscher oder einfach nur von CopywriterProAI begeistert sind, wir würden uns freuen, Sie in unserer Community zu haben. Lassen Sie uns gemeinsam die Erstellung von Inhalten verbessern!

• Discord-Server – Dies ist ein von der Community betriebener Server für allgemeine Diskussionen, Fragen und Feedback.