starred/ALwrity

Fork

You've already forked ALwrity

mirror of https://github.com/AJaySi/ALwrity.git synced 2026-04-25 08:55:58 +03:00

Code Issues 82 Projects Releases 4 Packages Wiki Activity

[PR #312] [CLOSED] docs: Correct CopilotKit API Key Environment Variable #282

New issue

Closed

opened 2026-03-02 23:34:57 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 23:34:57 +03:00

Owner

Copy link

📋 Pull Request Information

Original PR: https://github.com/AJaySi/ALwrity/pull/312
Author: @oxcodexo
Created: 11/22/2025
Status: ❌ Closed

Base: main ← Head: fix/copilot-env-variable-name

📝 Commits (1)

76d0ff1 docs: Correct CopilotKit API key environment variable

📊 Changes

4 files changed (+4 additions, -4 deletions)

View changed files

📝 docs-site/docs/getting-started/configuration.md (+1 -1)
📝 docs-site/docs/getting-started/installation.md (+1 -1)
📝 docs-site/docs/getting-started/quick-start.md (+1 -1)
📝 docs-site/docs/user-journeys/developers/contributing.md (+1 -1)

📄 Description

Pull Request

📝 Description

This PR corrects a mismatch between the documentation and the application code regarding the CopilotKit API key environment variable. The documentation incorrectly instructed users to use REACT_APP_COPILOT_API_KEY, while the application code expects REACT_APP_COPILOTKIT_API_KEY.

Changes:

Updated [docs/getting-started/installation.md]
Updated [docs/getting-started/configuration.md]
Updated [docs/getting-started/quick-start.md](
Updated [docs/user-journeys/developers/contributing.md]

🔄 Type of Change

🐛 Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
📚 Documentation update
🎨 Style/UI changes
♻️ Code refactoring
⚡ Performance improvements
🧪 Test additions/updates

🎯 Related Issues

Fixes the "Chat Unavailable - CopilotKit API key not configured" error even when a key was provided in .env.

🧪 Testing

Backend tests pass
Frontend tests pass
Manual testing completed
Cross-browser testing (if applicable)
Mobile testing (if applicable)

Verification:

Updated .env with REACT_APP_COPILOTKIT_API_KEY.
Restarted the frontend server.
Verified that the "Chat Unavailable" banner disappeared and the AI assistant initialized correctly.

📸 Screenshots (if applicable)

N/A

🏷️ Component/Feature

Which component or feature is affected?

Blog Writer
SEO Dashboard
Content Planning
Facebook Writer
LinkedIn Writer
Onboarding
Authentication
API
Database
GSC Integration
Subscription System
Monitoring/Billing
Documentation
Other: _______________

📋 Checklist

My code follows the project's style guidelines
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published

ALwrity-Specific Checklist

API endpoints follow RESTful conventions
AI service integrations handle rate limits and errors gracefully
Content generation includes proper validation and sanitization
Database migrations are included if schema changes are made
Environment variables are documented in env_template.txt
Security considerations have been addressed
Performance impact has been considered
User experience is consistent with existing features

🔍 Code Quality

Code is properly formatted
No console.log statements left in production code
Error handling is implemented where needed
Performance considerations have been addressed
Security considerations have been addressed

📚 Documentation

README updated (if needed)
API documentation updated (if needed)
Code comments added for complex logic
Changelog updated (if applicable)

🚀 Deployment Notes

Users updating to this version must rename REACT_APP_COPILOT_API_KEY to REACT_APP_COPILOTKIT_API_KEY in their frontend .env file.

🔗 Additional Context

This aligns the documentation with the existing implementation in [frontend/src/App.tsx].

👥 Reviewers

Tag specific reviewers if needed:
@AJaySi @uniqueumesh @DikshaDisciplines

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/AJaySi/ALwrity/pull/312 **Author:** [@oxcodexo](https://github.com/oxcodexo) **Created:** 11/22/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `fix/copilot-env-variable-name` --- ### 📝 Commits (1) - [`76d0ff1`](https://github.com/AJaySi/ALwrity/commit/76d0ff19970c60f8cd35804c482c913145fbdd5f) docs: Correct CopilotKit API key environment variable ### 📊 Changes **4 files changed** (+4 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `docs-site/docs/getting-started/configuration.md` (+1 -1) 📝 `docs-site/docs/getting-started/installation.md` (+1 -1) 📝 `docs-site/docs/getting-started/quick-start.md` (+1 -1) 📝 `docs-site/docs/user-journeys/developers/contributing.md` (+1 -1) </details> ### 📄 Description # Pull Request ## 📝 Description This PR corrects a mismatch between the documentation and the application code regarding the CopilotKit API key environment variable. The documentation incorrectly instructed users to use `REACT_APP_COPILOT_API_KEY`, while the application code expects `REACT_APP_COPILOTKIT_API_KEY`. **Changes:** * Updated [docs/getting-started/installation.md] * Updated [docs/getting-started/configuration.md] * Updated [docs/getting-started/quick-start.md]( * Updated [docs/user-journeys/developers/contributing.md] ## 🔄 Type of Change - [x] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] ✨ New feature (non-breaking change which adds functionality) - [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 📚 Documentation update - [ ] 🎨 Style/UI changes - [ ] ♻️ Code refactoring - [ ] ⚡ Performance improvements - [ ] 🧪 Test additions/updates ## 🎯 Related Issues Fixes the "Chat Unavailable - CopilotKit API key not configured" error even when a key was provided in `.env`. ## 🧪 Testing - [ ] Backend tests pass - [ ] Frontend tests pass - [x] Manual testing completed - [ ] Cross-browser testing (if applicable) - [ ] Mobile testing (if applicable) **Verification:** 1. Updated `.env` with `REACT_APP_COPILOTKIT_API_KEY`. 2. Restarted the frontend server. 3. Verified that the "Chat Unavailable" banner disappeared and the AI assistant initialized correctly. ## 📸 Screenshots (if applicable) N/A ## 🏷️ Component/Feature Which component or feature is affected? - [ ] Blog Writer - [ ] SEO Dashboard - [ ] Content Planning - [ ] Facebook Writer - [ ] LinkedIn Writer - [ ] Onboarding - [ ] Authentication - [ ] API - [ ] Database - [ ] GSC Integration - [ ] Subscription System - [ ] Monitoring/Billing - [x] Documentation - [ ] Other: _______________ ## 📋 Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published ### ALwrity-Specific Checklist - [ ] API endpoints follow RESTful conventions - [ ] AI service integrations handle rate limits and errors gracefully - [ ] Content generation includes proper validation and sanitization - [ ] Database migrations are included if schema changes are made - [x] Environment variables are documented in env_template.txt - [ ] Security considerations have been addressed - [ ] Performance impact has been considered - [x] User experience is consistent with existing features ## 🔍 Code Quality - [x] Code is properly formatted - [x] No console.log statements left in production code - [ ] Error handling is implemented where needed - [ ] Performance considerations have been addressed - [ ] Security considerations have been addressed ## 📚 Documentation - [ ] README updated (if needed) - [ ] API documentation updated (if needed) - [ ] Code comments added for complex logic - [ ] Changelog updated (if applicable) ## 🚀 Deployment Notes Users updating to this version must rename `REACT_APP_COPILOT_API_KEY` to `REACT_APP_COPILOTKIT_API_KEY` in their frontend `.env` file. ## 🔗 Additional Context This aligns the documentation with the existing implementation in [frontend/src/App.tsx]. ## 👥 Reviewers Tag specific reviewers if needed: @AJaySi @uniqueumesh @DikshaDisciplines --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-03-02 23:34:57 +03:00

closed this issue
added the
pull-request
label

kerem referenced this issue

2026-03-13 20:48:37 +03:00

[GH-ISSUE #282] [BUG] ALwrity Vercel App is Having Issue During Configuration #536

No Branch/Tag specified

main

codex/task-title-3y5pbt

codex/task-title-lsrpho

codex/task-title

codex/locate-and-render-brollinfopanel-component

codex/import-scene-composition-symbols-in-broll_service

codex/refactor-preview-generation-flow

codex/standardize-chart-preview-route-usage

codex/import-b-roll-handler-and-update-router

codex/implement-podcast-research-response-updates

codex/add-cost-estimation-feature-to-podcastdashboard

codex/remove-heuristic-calculators-and-update-estimates-bhvhnh

codex/remove-heuristic-calculators-and-update-estimates

codex/implement-dedicated-podcastcostest-model

codex/add-podcast-maker-feature-documentation

codex/review-flat-file-context-system-implementation

codex/create-podcast-maker-best-practices-documentation

codex/add-podcast-maker-journey-pages-for-personas

codex/refactor-podcast-maker-documentation-structure

dependabot/npm_and_yarn/frontend/npm_and_yarn-7d3393088f

codex/log-skipped-and-loaded-items

codex/create-startup-phases-for-podcast-demo-tugrzv

codex/create-startup-phases-for-podcast-demo

codex/add-api-feature-profile-status-endpoint

codex/refactor-routermanager-to-use-registry

codex/add-new-modules-for-feature-management

codex/downgrade-api-key-warning-logging

codex/refactor-onboarding-loading-logic

codex/add-ci-lint-check-for-user_id-patterns

codex/remove-sessionlocal-import-and-add-health-check

codex/refactor-dubbed_audio_dir-to-tenant-path-resolver

codex/update-task-metadata-and-api-responses

codex/verify-podcast-analysis-and-cost-tracking

codex/assert-api-endpoints-on-startup

codex/add-env-controlled-guard-for-stripe-key

codex/remove-feature-flag-for-production-demo

codex/add-mode-aware-redirect-logic-in-pricingpage

codex/document-deployment-configuration-for-demo-mode

codex/ensure-api.subscription.router-always-included

codex/guard-onboarding-manager-and-endpoints

codex/wrap-router-inclusion-in-demo-mode-check

codex/add-podcast-only-demo-mode-toggle

dependabot/npm_and_yarn/frontend/npm_and_yarn-f5ea90b336

codex/update-reset_current_billing_period-logic

codex/update-error-handling-in-monitoring-middleware

codex/move-stripe_plan_price_mapping-to-env-driven-config

codex/refactor-billingservice-to-use-authenticated-user

codex/update-user-access-verification-for-routes

session/agent_eae6711f-e04b-4d48-8d66-43ee051feb7b

v0.5.0

v0.3

v0.2

v0.1

Labels

Clear labels

RAG knowledgebase Memory

Mirrored from GitHub Pull Request

No labels

RAG knowledgebase Memory

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/ALwrity#282

Reference in a new issue

Repository

starred/ALwrity

Title

Body

No description provided.

Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?

Rows
Columns