Massbug/judge4c
2
0
Fork 0
mirror of https://github.com/massbug/judge4c.git synced 2025-05-17 23:12:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(readme): rename project to Judge4c and enhance authentication & AI integration

Browse Source
This commit is contained in:
cfngc4594 2025-03-25 22:14:13 +08:00
parent b9c843e33e
commit 433cabebc4
1 changed files with 21 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,30 +1,13 @@
<div align="center">
# monaco-editor-lsp-next
# Judge4c
✨ A seamless Next.js integration of the Monaco Editor with robust LSP support – all without SSR hassles.
✨ A full-stack, open-source online judge platform designed to elevate college programming education.
![demo](demo.png)
</div>
## ⚠️ LSP Configuration and Environment Variable Limitations
**Warning: Pre-built Image LSP Configuration Limitations**
The pre-built Docker image `cfngc4594/monaco-editor-lsp-next` is configured to connect exclusively to `ws://localhost:4594/clangd` and `ws://localhost:4595/clangd`. This is due to the LSP configuration being set via `NEXT_PUBLIC` environment variables during the image build process.
* **Build-Time Freezing:** As per the Next.js [official documentation](https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables#bundling-environment-variables-for-the-browser), `NEXT_PUBLIC` variables are frozen at build time, and subsequent changes are ineffective.
* **Local LSP Server Dependency:** Therefore, the pre-built image can only connect to the specified local LSP servers.
* **Custom Configuration Requirement:** If you wish to define your own LSP configuration via environment variables, you **cannot** use the pre-built image. Instead, you must:
* Clone the source code.
* Set your desired environment variables.
* Manually build the Docker image.
**Upcoming Improvements (v0.0.1):**
To address these limitations, v0.0.1 will implement the officially recommended API approach for retrieving LSP configurations, enabling runtime dynamic LSP server configuration without image rebuilding.
## ⚠️ WSL Users: Critical Configuration
### 🐧 Network Mode Requirement
@ -49,8 +32,8 @@ Deploy the project quickly using Docker. Follow the steps below:
#### Step 1: Clone the Repository
```shell
git clone https://github.com/cfngc4594/monaco-editor-lsp-next
cd monaco-editor-lsp-next
git clone https://github.com/massbug/judge4c
cd judge4c
```
#### Step 2: Install Dependencies
@ -99,6 +82,19 @@ bun install
AUTH_GITHUB_SECRET="your_github_client_secret"
```
- **Authentication Callback URL**:
Set the base URL for authentication callbacks (typically your app's domain):
```sh
AUTH_URL="http://localhost:3000" # Replace with your production URL if deployed
```
- **OpenAI API Configuration** (Optional):
If you use OpenAI-based features, provide your API key and custom endpoint (if applicable):
```sh
OPENAI_API_KEY="your_openai_api_key" # Required for AI features
OPENAI_BASE_URL="your_openai_base_url_if_custom" # Optional, for self-hosted proxies
```
#### Step 4: Start the Application
Once the environment variables are configured, start the application using Docker Compose: