CopywriterProAI のバックエンド リポジトリへようこそ。これは、SEO と広告コピーのための世界初のオープンソース AI ライティング プラットフォームです。 CopywriterProAI のバックエンドは AI 機能を強化し、コンテンツの処理を管理し、スムーズで効率的な操作を保証します。それは、自分専用の AI ライティング アシスタントが舞台裏で働いていて、いつでも助けてくれるようなものです。
yarn
環境変数を設定する: .env.example ファイルからコピーし、新しい環境変数を追加します。
.env
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
ローカルで実行する
yarn dev
実稼働環境での実行
yarn start
開発者のセットアップを簡素化するために、単一の docker-compose up コマンドでプロジェクトを実行できる Docker 構成が提供されています。
リポジトリのクローンを作成します。
git clone https://github.com/CopywriterPro-ai/copywriterproai-backend
cd copywriterproai-backend
.env.sample ファイルを .env にコピーし、必要な構成を更新します。
cp .env.sample .env
docker-compose up --build
バックエンドは http://localhost:8080 で実行されます。
プロジェクトの詳細と、CopywriterProAI の使用に関するヒントについては、ドキュメントを参照してください。
そこでは、さまざまな LLM プロバイダーの使用方法、トラブルシューティング リソース、および高度な構成オプションに関するリソースが見つかります。
CopywriterProAI はコミュニティ主導のプロジェクトであり、皆様からの貢献を歓迎します。あなたが開発者、研究者、あるいは単に AI を使用したコンテンツ作成分野の進歩に熱心であるかどうかにかかわらず、参加するにはさまざまな方法があります。
詳細はCONTRIBUTING.mdをご確認ください。
あなたが開発者でも、研究者でも、単に CopywriterProAI に熱中している方でも、私たちのコミュニティに参加していただければ幸いです。一緒にコンテンツ制作を改善していきましょう!