Skip to content

Commit e7e8846

Browse files
author
Ajdin Lokvancic (TME)
committed
Initial commit before public repo release
0 parents  commit e7e8846

94 files changed

Lines changed: 54931 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.env.example‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Pterodactyl API Testing Configuration
2+
# Copy this file to .env and fill in your actual values
3+
4+
# Pterodactyl Panel Configuration
5+
PANEL_URL=https://panel.example.com
6+
PANEL_NODE_URL=wss://node.example.com:8080
7+
8+
# API Keys (Generate these from your Pterodactyl panel)
9+
CLIENT_API_KEY=ptlc_your_client_api_key_here
10+
APPLICATION_API_KEY=ptla_your_application_api_key_here
11+
12+
# Test Resources (Use existing IDs from your panel)
13+
TEST_SERVER_ID=d3aac109
14+
TEST_USER_ID=1
15+
TEST_NODE_ID=1
16+
TEST_LOCATION_ID=1
17+
18+
# Test Configuration
19+
SKIP_DESTRUCTIVE_TESTS=true
20+
TEST_TIMEOUT=30000
21+
RUN_WEBSOCKET_TESTS=false
22+
23+
# Test User Generation
24+
TEST_EMAIL_DOMAIN=example.com
25+
TEST_USERNAME_PREFIX=testuser
26+
27+
# Optional: Custom test output file
28+
# TEST_OUTPUT_FILE=test-results.json
29+
30+
# Optional: Enable verbose logging
31+
# VERBOSE=false

‎.github/ISSUE_TEMPLATE/documentation_improvement.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest an improvement to the documentation
4+
title: ''
5+
labels: enhancement, documentation
6+
assignees: ''
7+
8+
---
9+
10+
## 📖 Documentation Improvement
11+
12+
### 📍 Location
13+
Please specify which part of the documentation needs improvement:
14+
- **Page URL**:
15+
- **Section**:
16+
- **Specific endpoint** (if applicable):
17+
18+
### 🎯 Type of Improvement
19+
- [ ] Missing information
20+
- [ ] Unclear explanation
21+
- [ ] Outdated content
22+
- [ ] Missing code examples
23+
- [ ] Missing language examples
24+
- [ ] Formatting issues
25+
- [ ] Other: ___________
26+
27+
### 💡 Suggested Improvement
28+
A clear and concise description of what you'd like to see improved.
29+
30+
### 🔍 Current Content (if applicable)
31+
Quote or describe the current content that needs improvement.
32+
33+
### ✨ Proposed Content
34+
Describe or provide the improved content you'd like to see.
35+
36+
### 🎁 Additional Value
37+
Explain how this improvement would help other developers.
38+
39+
### 📋 Additional Context
40+
Add any other context, links, or screenshots about the improvement suggestion.

‎.github/pull_request_template.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## 📋 Pull Request Description
2+
3+
### 🎯 Type of Change
4+
- [ ] Bug fix (non-breaking change which fixes an issue)
5+
- [ ] New feature (non-breaking change which adds functionality)
6+
- [ ] Documentation improvement
7+
- [ ] Code example update
8+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
9+
10+
### 📖 What does this PR do?
11+
A clear and concise description of what this pull request accomplishes.
12+
13+
### 🔍 Related Issue
14+
Fixes #(issue number) or Closes #(issue number)
15+
16+
### 📍 Changes Made
17+
- [ ] Updated documentation content
18+
- [ ] Added/updated code examples
19+
- [ ] Fixed typos or formatting
20+
- [ ] Added new API endpoint documentation
21+
- [ ] Updated existing API endpoint documentation
22+
- [ ] Other: ___________
23+
24+
### 🧪 Testing
25+
- [ ] I have tested all code examples
26+
- [ ] Documentation builds without errors (`npm run build`)
27+
- [ ] All links work correctly
28+
- [ ] Multi-language examples are consistent
29+
- [ ] Changes are responsive on different screen sizes
30+
31+
### 📸 Screenshots (if applicable)
32+
Add screenshots to show visual changes.
33+
34+
### 📋 Checklist
35+
- [ ] My code follows the style guidelines of this project
36+
- [ ] I have performed a self-review of my changes
37+
- [ ] I have commented my code, particularly in hard-to-understand areas
38+
- [ ] My changes generate no new warnings
39+
- [ ] I have added examples that prove my fix is effective or that my feature works
40+
- [ ] New and existing tests pass locally with my changes
41+
42+
### 📝 Additional Notes
43+
Any additional information or context about the pull request.

‎.github/workflows/build.yml‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Build Documentation
2+
3+
on:
4+
push:
5+
branches: [ main, master ]
6+
pull_request:
7+
branches: [ main, master ]
8+
9+
jobs:
10+
build:
11+
name: Build and Test
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
node-version: [20.x]
17+
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
22+
- name: Setup Node.js ${{ matrix.node-version }}
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: ${{ matrix.node-version }}
26+
cache: 'npm'
27+
28+
- name: Install dependencies
29+
run: npm ci
30+
31+
- name: Build documentation
32+
run: npm run build
33+
34+
- name: Test build output
35+
run: |
36+
if [ ! -d "build" ]; then
37+
echo "Build directory not found!"
38+
exit 1
39+
fi
40+
if [ ! -f "build/index.html" ]; then
41+
echo "Index.html not found in build!"
42+
exit 1
43+
fi
44+
echo "Build successful!"
45+
46+
- name: Upload build artifacts
47+
if: matrix.node-version == '20.x' && github.event_name == 'push'
48+
uses: actions/upload-artifact@v4
49+
with:
50+
name: documentation-build
51+
path: build/
52+
retention-days: 7
53+
54+
lint:
55+
name: Lint and Format Check
56+
runs-on: ubuntu-latest
57+
58+
steps:
59+
- name: Checkout repository
60+
uses: actions/checkout@v4
61+
62+
- name: Setup Node.js
63+
uses: actions/setup-node@v4
64+
with:
65+
node-version: '20.x'
66+
cache: 'npm'
67+
68+
- name: Install dependencies
69+
run: npm ci
70+
71+
- name: Check for TypeScript errors
72+
run: npx tsc --noEmit
73+
74+
- name: Check documentation links
75+
run: |
76+
echo "Checking for broken internal links..."
77+
npm run build 2>&1 | tee build.log
78+
if grep -q "Broken link" build.log; then
79+
echo "❌ Broken links found!"
80+
grep "Broken link" build.log
81+
exit 1
82+
else
83+
echo "✅ No broken links found!"
84+
fi

‎.gitignore‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Dependencies
2+
/node_modules
3+
/.pnp
4+
.pnp.js
5+
6+
# Production
7+
/build
8+
9+
# Generated files
10+
.docusaurus
11+
.cache-loader
12+
13+
# Environment files (keep all .env files out of repository)
14+
.env*
15+
!.env.example
16+
17+
# Logs
18+
*.log
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
lerna-debug.log*
23+
24+
# Runtime data
25+
pids
26+
*.pid
27+
*.seed
28+
*.pid.lock
29+
30+
# Coverage directory used by tools like istanbul
31+
coverage/
32+
*.lcov
33+
34+
# Dependency directories
35+
node_modules/
36+
jspm_packages/
37+
38+
# Optional npm cache directory
39+
.npm
40+
41+
# Optional eslint cache
42+
.eslintcache
43+
44+
# Yarn Integrity file
45+
.yarn-integrity
46+
47+
# AI Assistants, IDE and editor files
48+
.vscode/
49+
.idea/
50+
*.swp
51+
*.swo
52+
*~
53+
CLAUDE.md
54+
.claude
55+
GISCUS_SETUP.md
56+
57+
# OS generated files
58+
.DS_Store
59+
.DS_Store?
60+
._*
61+
.Spotlight-V100
62+
.Trashes
63+
ehthumbs.db
64+
Thumbs.db
65+
66+
# Test logs and artifacts
67+
tests/logs/
68+
test-results/
69+
*.test.log
70+
71+
# Temporary files
72+
*.tmp
73+
*.temp

0 commit comments

Comments
 (0)