LangX Copilot is an innovative AI-powered tool designed to enhance your language learning journey. This feature-rich platform offers personalized feedback to improve your language skills in real-time. LangX Copilot ensures your privacy while providing corrections and explanations directly to you.
You can try out LangX Copilot in the #copilot channel on Discord.
- Personalized Feedback: Get real-time corrections and explanations to enhance your language learning.
- Grammar Correction: Automatically corrects grammar mistakes and provides detailed explanations.
- Privacy Focused: Feedback is provided confidentially, ensuring your privacy is maintained.
- Supports Multiple Languages: Not limited to English, LangX Copilot supports various languages for grammar correction.
- Node.js (version 18 or later)
- npm (Node Package Manager)
- Cloudflare account with Workers enabled
- Discord account and bot set up in the Discord Developer Portal
-
Clone the repository:
git clone https://github.com/langx/copilot.git cd copilot
-
Install dependencies:
npm install
-
Copy
.env
file with the following environment variables:cp .env.sample .env
-
Fill in the environment variables in the
.env
file:DISCORD_BOT_TOKEN=your_discord_token DISCORD_CLIENT_ID=your_discord_client_id GEMINI_API_KEY=your_gemini_api_key
-
Set up the system instructions:
cp instructions.js.sample instructions.js
Open the
instructions.js
file in your preferred text editor and edit thesystemInstruction
andchatHistory
constant to include your own instructions. -
Run the application:
npm start discord
-
Deploy the Bot (Optional):
npm i pm2 -g node discord/registerCommands.js pm2 start discord/bot.js --name copilot
Feel free to contribute to this project and help us improve LangX Copilot. You can contribute by opening a PR or creating an issue easily.
We welcome all contributions, including bug fixes, new features, and improvements to the documentation.
This project is licensed under BSD 3-Clause License. See the LICENSE file for more details.