0x5t4l1n/OpenLearnX
1
0
Fork 0
mirror of https://github.com/th30d4y/OpenLearnX.git synced 2026-05-26 19:26:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #78 from th30d4y/copilot/update-openlearnx-readme

Browse Source 
Fix npm/release metadata to consistently reflect v2.0.4 scoped package
This commit is contained in:
Stalin
2026-05-08 12:39:26 +05:30
committed by GitHub
parent 5b240bc23f 01f2187e36
commit d92ca944f1
7 changed files with 47 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
NPM_PUBLISHING_GUIDE.md
+15 -15
View File
@@ -47,18 +47,18 @@ npm publish
# Expected output: # Expected output:
# npm notice # npm notice
# npm notice 📦 openlearnx@2.0.4 # npm notice 📦 @th30d4y/openlearnx@2.0.4
# npm notice === Tarball Contents === # npm notice === Tarball Contents ===
# npm notice ... # npm notice ...
# npm notice === Dist Files === # npm notice === Dist Files ===
# npm notice ... # npm notice ...
# npm notice === Tarball Details === # npm notice === Tarball Details ===
# npm notice name: openlearnx # npm notice name: @th30d4y/openlearnx
# npm notice version: 2.0.4 # npm notice version: 2.0.4
# npm notice filename: openlearnx-2.0.4.tgz # npm notice filename: th30d4y-openlearnx-2.0.4.tgz
# npm notice published: [timestamp] # npm notice published: [timestamp]
# npm notice public # npm notice public
# npm notice url: https://www.npmjs.com/package/openlearnx # npm notice url: https://www.npmjs.com/package/@th30d4y/openlearnx
# npm notice access: public # npm notice access: public
# npm notice... # npm notice...
``` ```
@@ -67,13 +67,13 @@ npm publish
```bash ```bash
# Check the package on NPM registry # Check the package on NPM registry
npm view openlearnx npm view @th30d4y/openlearnx
# Check specific version # Check specific version
npm view openlearnx@2.0.4 npm view @th30d4y/openlearnx@2.0.4
# You should see: # You should see:
# openlearnx@2.0.4 | ISC | deps: 39 | versions: 2 # @th30d4y/openlearnx@2.0.4 | ISC | deps: 39 | versions: 2
``` ```
## Step 5: Test Installation ## Step 5: Test Installation
@@ -82,11 +82,11 @@ npm view openlearnx@2.0.4
# Test in a clean directory # Test in a clean directory
mkdir /tmp/test-openlearnx && cd /tmp/test-openlearnx mkdir /tmp/test-openlearnx && cd /tmp/test-openlearnx
npm init -y npm init -y
npm install openlearnx@2.0.4 npm install @th30d4y/openlearnx@2.0.4
# Verify the installation # Verify the installation
npm list openlearnx npm list @th30d4y/openlearnx
# Should show: openlearnx@2.0.4 # Should show: @th30d4y/openlearnx@2.0.4
``` ```
## Alternative: Using npm ci (for CI/CD) ## Alternative: Using npm ci (for CI/CD)
@@ -111,7 +111,7 @@ npm publish
### Issue: "This version has already been published" ### Issue: "This version has already been published"
**Solution:** **Solution:**
- Use a different version number - Use a different version number
- Use `npm unpublish openlearnx@2.0.4` (if allowed) and republish - Use `npm unpublish @th30d4y/openlearnx@2.0.4` (if allowed) and republish
### Issue: "npm notice... WARN" ### Issue: "npm notice... WARN"
**Solution:** These are usually non-critical warnings. Review them but the publish should still succeed. **Solution:** These are usually non-critical warnings. Review them but the publish should still succeed.
@@ -129,13 +129,13 @@ npm publish
- Recommend immediate upgrade - Recommend immediate upgrade
3. **Verify in Package Managers:** 3. **Verify in Package Managers:**
- NPM: https://www.npmjs.com/package/openlearnx - NPM: https://www.npmjs.com/package/@th30d4y/openlearnx
- Check latest version shows 2.0.4 - Check latest version shows 2.0.4
## Package Details ## Package Details
``` ```
Package Name: openlearnx Package Name: @th30d4y/openlearnx
Version: 2.0.4 Version: 2.0.4
Description: AI-powered learning platform with adaptive quizzes, coding practice, course tracking, and dashboard analytics Description: AI-powered learning platform with adaptive quizzes, coding practice, course tracking, and dashboard analytics
Repository: https://github.com/th30d4y/OpenLearnX Repository: https://github.com/th30d4y/OpenLearnX
@@ -146,10 +146,10 @@ Registry: https://registry.npmjs.org
```bash ```bash
# Install the latest version (2.0.4) # Install the latest version (2.0.4)
npm install openlearnx@2.0.4 npm install @th30d4y/openlearnx@2.0.4
# Or install the latest # Or install the latest
npm install openlearnx@latest npm install @th30d4y/openlearnx@latest
``` ```
--- ---
NPM_PUBLISH_FIXED.md
+17 -17
View File
@@ -50,23 +50,23 @@ npm pack
# You should see: # You should see:
# npm notice # npm notice
# npm notice 📦 openlearnx@2.0.4 # npm notice 📦 @th30d4y/openlearnx@2.0.4
# npm notice === Tarball Contents === # npm notice === Tarball Contents ===
# ...files being packaged... # ...files being packaged...
# npm notice === Tarball Details === # npm notice === Tarball Details ===
# ... # ...
# openlearnx-2.0.4.tgz # th30d4y-openlearnx-2.0.4.tgz
# Extract and inspect # Extract and inspect
mkdir test-package mkdir test-package
cd test-package cd test-package
tar -xzf ../openlearnx-2.0.4.tgz tar -xzf ../th30d4y-openlearnx-2.0.4.tgz
ls -la package/ ls -la package/
# Verify only necessary files are included # Verify only necessary files are included
cd .. cd ..
rm -rf test-package rm -rf test-package
rm openlearnx-2.0.4.tgz rm th30d4y-openlearnx-2.0.4.tgz
``` ```
### Step 3: Login to NPM ### Step 3: Login to NPM
@@ -90,11 +90,11 @@ npm publish
# Expected output: # Expected output:
# npm notice # npm notice
# npm notice 📦 openlearnx@2.0.4 # npm notice 📦 @th30d4y/openlearnx@2.0.4
# npm notice === Tarball Contents === # npm notice === Tarball Contents ===
# npm notice name: openlearnx # npm notice name: @th30d4y/openlearnx
# npm notice version: 2.0.4 # npm notice version: 2.0.4
# npm notice filename: openlearnx-2.0.4.tgz # npm notice filename: th30d4y-openlearnx-2.0.4.tgz
# npm notice published: [timestamp] # npm notice published: [timestamp]
# npm notice public # npm notice public
# npm notice access: public # npm notice access: public
@@ -104,13 +104,13 @@ npm publish
### Step 5: Verify Publication ### Step 5: Verify Publication
```bash ```bash
# Check on NPM registry # Check on NPM registry
npm view openlearnx npm view @th30d4y/openlearnx
# Check specific version # Check specific version
npm view openlearnx@2.0.4 npm view @th30d4y/openlearnx@2.0.4
# Check package page # Check package page
# Visit: https://www.npmjs.com/package/openlearnx # Visit: https://www.npmjs.com/package/@th30d4y/openlearnx
``` ```
### Step 6: Test Installation from Another Directory ### Step 6: Test Installation from Another Directory
@@ -122,12 +122,12 @@ cd openlearnx-test
npm init -y npm init -y
# Install the published package # Install the published package
npm install openlearnx@2.0.4 npm install @th30d4y/openlearnx@2.0.4
# Verify installation # Verify installation
ls node_modules/openlearnx/ ls node_modules/@th30d4y/openlearnx/
npm list openlearnx npm list @th30d4y/openlearnx
# Should show: openlearnx@2.0.4 # Should show: @th30d4y/openlearnx@2.0.4
``` ```
## 🔍 Troubleshooting ## 🔍 Troubleshooting
@@ -172,7 +172,7 @@ npm view [package-name]
## 📦 Package Contents ## 📦 Package Contents
The published `openlearnx@2.0.4` package includes: The published `@th30d4y/openlearnx@2.0.4` package includes:
``` ```
README.md README.md
@@ -199,7 +199,7 @@ This release (`2.0.4`) contains critical security fixes:
**All users should upgrade immediately:** **All users should upgrade immediately:**
```bash ```bash
npm install openlearnx@2.0.4 npm install @th30d4y/openlearnx@2.0.4
``` ```
## 📝 Post-Publishing ## 📝 Post-Publishing
@@ -225,7 +225,7 @@ npm install openlearnx@2.0.4
## 🔗 Useful Links ## 🔗 Useful Links
- **NPM Package:** https://www.npmjs.com/package/openlearnx - **NPM Package:** https://www.npmjs.com/package/@th30d4y/openlearnx
- **GitHub Repository:** https://github.com/th30d4y/OpenLearnX - **GitHub Repository:** https://github.com/th30d4y/OpenLearnX
- **Security Advisory:** https://github.com/th30d4y/OpenLearnX/security/advisories/GHSA-223g-f5mq-gw33 - **Security Advisory:** https://github.com/th30d4y/OpenLearnX/security/advisories/GHSA-223g-f5mq-gw33
- **Changelog:** [CHANGELOG.md](CHANGELOG.md) - **Changelog:** [CHANGELOG.md](CHANGELOG.md)
QUICK_PUBLISH.md
+6 -6
View File
@@ -40,8 +40,8 @@ npm publish
# Expected output: # Expected output:
# npm notice # npm notice
# npm notice 📦 openlearnx@2.0.4 # npm notice 📦 @th30d4y/openlearnx@2.0.4
# npm notice filename: openlearnx-2.0.4.tgz # npm notice filename: th30d4y-openlearnx-2.0.4.tgz
# npm notice published: [timestamp] # npm notice published: [timestamp]
# npm notice public # npm notice public
``` ```
@@ -49,22 +49,22 @@ npm publish
### Step 5: Verify It's Published ### Step 5: Verify It's Published
```bash ```bash
# Check on npm registry # Check on npm registry
npm view openlearnx@2.0.4 npm view @th30d4y/openlearnx@2.0.4
# Or visit: https://www.npmjs.com/package/openlearnx # Or visit: https://www.npmjs.com/package/@th30d4y/openlearnx
``` ```
## That's It! ✨ ## That's It! ✨
Users can now install with: Users can now install with:
```bash ```bash
npm install openlearnx@2.0.4 npm install @th30d4y/openlearnx@2.0.4
``` ```
## What Was Published ## What Was Published
``` ```
openlearnx v2.0.4 @th30d4y/openlearnx v2.0.4
├─ Security Fix: JWT Signature Verification (GHSA-223g-f5mq-gw33) ├─ Security Fix: JWT Signature Verification (GHSA-223g-f5mq-gw33)
├─ Framework: Next.js 16.1.6 + React 19.2.5 ├─ Framework: Next.js 16.1.6 + React 19.2.5
├─ Features: Adaptive quizzes, AI recommendations, Code compilation ├─ Features: Adaptive quizzes, AI recommendations, Code compilation
RELEASE_SUMMARY.md
+3 -5
View File
@@ -137,15 +137,13 @@ npm login
npm publish npm publish
# 3. Verify # 3. Verify
npm view openlearnx@2.0.4 npm view @th30d4y/openlearnx@2.0.4
``` ```
## ✨ Installation Command for Users ## ✨ Installation Command for Users
```bash ```bash
npm install openlearnx@2.0.4 npm install @th30d4y/openlearnx@2.0.4
# or
npm install @th30d4y/openlearnx@2.0.4 # if scoped
``` ```
## 🔒 Security Advisory Details ## 🔒 Security Advisory Details
@@ -169,7 +167,7 @@ npm install @th30d4y/openlearnx@2.0.4 # if scoped
- **GitHub Advisory:** https://github.com/th30d4y/OpenLearnX-ghsa-223g-f5mq-gw33/security/advisories/GHSA-223g-f5mq-gw33 - **GitHub Advisory:** https://github.com/th30d4y/OpenLearnX-ghsa-223g-f5mq-gw33/security/advisories/GHSA-223g-f5mq-gw33
- **GitHub Repo:** https://github.com/th30d4y/OpenLearnX-ghsa-223g-f5mq-gw33 - **GitHub Repo:** https://github.com/th30d4y/OpenLearnX-ghsa-223g-f5mq-gw33
- **NPM Registry:** https://www.npmjs.com/package/openlearnx - **NPM Registry:** https://www.npmjs.com/package/@th30d4y/openlearnx
- **Advisory Fix Branch:** https://github.com/th30d4y/OpenLearnX-ghsa-223g-f5mq-gw33/tree/advisory-fix-1 - **Advisory Fix Branch:** https://github.com/th30d4y/OpenLearnX-ghsa-223g-f5mq-gw33/tree/advisory-fix-1
## 📞 Next Steps ## 📞 Next Steps
frontend/README.md
+1 -1
View File
@@ -5,7 +5,7 @@ OpenLearnX is an AI-powered learning platform with adaptive quizzes, coding prac
## Install ## Install
```bash ```bash
npm i openlearnx npm i @th30d4y/openlearnx@2.0.4
``` ```
## Project ## Project
frontend/package.json
+1 -1
View File
@@ -1,5 +1,5 @@
{ {
"name": "openlearnx", "name": "@th30d4y/openlearnx",
"version": "2.0.4", "version": "2.0.4",
"private": false, "private": false,
"scripts": { "scripts": {
test-npm-publish.sh
+4 -4
View File
@@ -47,8 +47,8 @@ if [ ! -f "package.json" ]; then
fi fi
# Check for required fields # Check for required fields
if grep -q '"name": "openlearnx"' package.json; then if grep -q '"name": "@th30d4y/openlearnx"' package.json; then
pass "Package name is correct: openlearnx" pass "Package name is correct: @th30d4y/openlearnx"
else else
fail "Package name is incorrect or missing" fail "Package name is incorrect or missing"
fi fi
@@ -121,7 +121,7 @@ fi
# Test 8: Dry run of package creation # Test 8: Dry run of package creation
echo "" echo ""
echo "📦 Test 8: Testing package creation (dry run)..." echo "📦 Test 8: Testing package creation (dry run)..."
if npm pack --dry-run 2>/dev/null | grep -q "openlearnx@2.0.4"; then if npm pack --dry-run 2>&1 | grep -q "@th30d4y/openlearnx@2.0.4"; then
pass "Package would be created successfully" pass "Package would be created successfully"
else else
fail "Package creation test failed" fail "Package creation test failed"
@@ -135,5 +135,5 @@ echo "🚀 Ready to publish:"
echo " npm publish" echo " npm publish"
echo "" echo ""
echo "Or test locally first:" echo "Or test locally first:"
echo " npm pack && tar -tzf openlearnx-2.0.4.tgz | head -20" echo " npm pack && tar -tzf th30d4y-openlearnx-2.0.4.tgz | head -20"
echo "" echo ""