Skip to content

Commit ca74589

Browse files
feat: Add advanced GitHub features and deployment options
- Add GitHub Pages documentation site with professional design - Add automated release workflow with changelog generation - Add CodeQL security analysis workflow - Add comprehensive deployment guide covering all platforms - Add Docker support with multi-stage builds and nginx - Add Docker Compose for development and production - Add advanced GitHub issue forms and funding configuration - Add nginx configuration with security headers and optimization - Add professional project documentation structure - Enable sponsorship and community engagement features
1 parent b3d543d commit ca74589

File tree

9 files changed

+801
-0
lines changed

9 files changed

+801
-0
lines changed

.github/FUNDING.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# These are supported funding model platforms
2+
3+
github: # skynetbee
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
14+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/skynetbee/ReactNeuralEngine/discussions
5+
about: For questions, ideas, and general discussion
6+
- name: 🆘 Stack Overflow
7+
url: https://stackoverflow.com/questions/tagged/react
8+
about: For technical React questions
9+
- name: 📧 Email Support
10+
url: mailto:support@reactneuralengine.com
11+
about: For private support inquiries
12+

.github/workflows/codeql.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: "CodeQL Analysis"
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main ]
8+
schedule:
9+
- cron: '0 6 * * 1' # Weekly on Monday at 6 AM UTC
10+
11+
jobs:
12+
analyze:
13+
name: Analyze
14+
runs-on: ubuntu-latest
15+
permissions:
16+
actions: read
17+
contents: read
18+
security-events: write
19+
20+
strategy:
21+
fail-fast: false
22+
matrix:
23+
language: [ 'javascript' ]
24+
25+
steps:
26+
- name: Checkout repository
27+
uses: actions/checkout@v4
28+
29+
- name: Initialize CodeQL
30+
uses: github/codeql-action/init@v2
31+
with:
32+
languages: ${{ matrix.language }}
33+
queries: security-extended,security-and-quality
34+
35+
- name: Autobuild
36+
uses: github/codeql-action/autobuild@v2
37+
38+
- name: Perform CodeQL Analysis
39+
uses: github/codeql-action/analyze@v2
40+
with:
41+
category: "/language:${{matrix.language}}"
42+

.github/workflows/release.yml

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*.*.*'
7+
8+
jobs:
9+
release:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
18+
- name: Setup Node.js
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: '18.x'
22+
cache: 'npm'
23+
24+
- name: Install dependencies
25+
run: npm ci
26+
27+
- name: Run tests
28+
run: npm test -- --coverage --watchAll=false
29+
30+
- name: Build for production
31+
run: npm run build
32+
33+
- name: Create deployment package
34+
run: |
35+
cd build
36+
zip -r ../react-neural-engine-${{ github.ref_name }}.zip .
37+
cd ..
38+
tar -czf react-neural-engine-${{ github.ref_name }}.tar.gz -C build .
39+
40+
- name: Generate changelog
41+
id: changelog
42+
run: |
43+
if [ -f CHANGELOG.md ]; then
44+
echo "CHANGELOG<<EOF" >> $GITHUB_OUTPUT
45+
sed -n '/^## \[/,/^## \[/{ /^## \[/{ N; }; /^## \[/!p; }' CHANGELOG.md | head -n -1 >> $GITHUB_OUTPUT
46+
echo "EOF" >> $GITHUB_OUTPUT
47+
else
48+
echo "CHANGELOG=Release ${{ github.ref_name }}" >> $GITHUB_OUTPUT
49+
fi
50+
51+
- name: Create GitHub Release
52+
uses: actions/create-release@v1
53+
env:
54+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
55+
with:
56+
tag_name: ${{ github.ref_name }}
57+
release_name: Release ${{ github.ref_name }}
58+
body: |
59+
## 🚀 Release ${{ github.ref_name }}
60+
61+
### 📋 Changes
62+
${{ steps.changelog.outputs.CHANGELOG }}
63+
64+
### 📦 Downloads
65+
- **ZIP Package**: `react-neural-engine-${{ github.ref_name }}.zip`
66+
- **TAR.GZ Package**: `react-neural-engine-${{ github.ref_name }}.tar.gz`
67+
68+
### 🚀 Deployment
69+
1. Download one of the packages above
70+
2. Extract to your web server or XAMPP htdocs
71+
3. Navigate to the application URL
72+
73+
### 📖 Documentation
74+
Visit our [documentation site](https://skynetbee.github.io/ReactNeuralEngine/) for detailed setup instructions.
75+
draft: false
76+
prerelease: false
77+
78+
- name: Upload ZIP Release Asset
79+
uses: actions/upload-release-asset@v1
80+
env:
81+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
82+
with:
83+
upload_url: ${{ steps.create_release.outputs.upload_url }}
84+
asset_path: ./react-neural-engine-${{ github.ref_name }}.zip
85+
asset_name: react-neural-engine-${{ github.ref_name }}.zip
86+
asset_content_type: application/zip
87+
88+
- name: Upload TAR.GZ Release Asset
89+
uses: actions/upload-release-asset@v1
90+
env:
91+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
92+
with:
93+
upload_url: ${{ steps.create_release.outputs.upload_url }}
94+
asset_path: ./react-neural-engine-${{ github.ref_name }}.tar.gz
95+
asset_name: react-neural-engine-${{ github.ref_name }}.tar.gz
96+
asset_content_type: application/gzip
97+

0 commit comments

Comments
 (0)