Skip to content

Commit 33f27c8

Browse files
author
Yann VR
committed
Remove manual setup guide and add quick start documentation
- Deleted MANUAL_SETUP.md to streamline repository documentation. - Introduced QUICK_START.md for a concise, one-command setup guide for external developers. - Updated README.md to include quick integration instructions and enhance user onboarding experience. - Added configuration guide in CONFIG.md for better customization options. - Implemented integration and user journey tests to ensure smooth developer experience.
1 parent 0fcc840 commit 33f27c8

File tree

12 files changed

+2123
-144
lines changed

12 files changed

+2123
-144
lines changed

.github/workflows/test.yml

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
name: Test External Integration
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [16.x, 18.x, 20.x]
16+
17+
steps:
18+
- uses: actions/checkout@v3
19+
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v3
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
cache: 'npm'
25+
26+
- name: Install dependencies
27+
run: npm ci
28+
29+
- name: Make scripts executable
30+
run: npm run build
31+
32+
- name: Run integration tests
33+
run: npm run test:integration
34+
35+
- name: Run user journey tests
36+
run: npm run test:journey
37+
38+
- name: Test CLI accessibility
39+
run: |
40+
node bin/pdc.js --version
41+
node bin/pdc.js --help
42+
43+
- name: Test setup script
44+
run: |
45+
node bin/setup.js --help
46+
47+
test-package-managers:
48+
runs-on: ubuntu-latest
49+
50+
strategy:
51+
matrix:
52+
pm: [npm, yarn, pnpm]
53+
54+
steps:
55+
- uses: actions/checkout@v3
56+
57+
- name: Use Node.js 18.x
58+
uses: actions/setup-node@v3
59+
with:
60+
node-version: 18.x
61+
cache: 'npm'
62+
63+
- name: Install dependencies
64+
run: npm ci
65+
66+
- name: Setup package manager
67+
run: |
68+
if [ "${{ matrix.pm }}" = "yarn" ]; then
69+
npm install -g yarn
70+
elif [ "${{ matrix.pm }}" = "pnpm" ]; then
71+
npm install -g pnpm
72+
fi
73+
74+
- name: Test with ${{ matrix.pm }}
75+
run: |
76+
# Create test project
77+
mkdir test-pm-${{ matrix.pm }}
78+
cd test-pm-${{ matrix.pm }}
79+
80+
# Initialize project
81+
if [ "${{ matrix.pm }}" = "yarn" ]; then
82+
yarn init -y
83+
yarn add react@18
84+
touch yarn.lock
85+
elif [ "${{ matrix.pm }}" = "pnpm" ]; then
86+
pnpm init -y
87+
pnpm add react@18
88+
touch pnpm-lock.yaml
89+
else
90+
npm init -y
91+
npm install react@18
92+
fi
93+
94+
# Test CLI works
95+
node ../bin/pdc.js --help
96+
97+
test-real-world-setup:
98+
runs-on: ubuntu-latest
99+
100+
steps:
101+
- uses: actions/checkout@v3
102+
103+
- name: Use Node.js 18.x
104+
uses: actions/setup-node@v3
105+
with:
106+
node-version: 18.x
107+
cache: 'npm'
108+
109+
- name: Install dependencies
110+
run: npm ci
111+
112+
- name: Create real-world test project
113+
run: |
114+
mkdir real-world-test
115+
cd real-world-test
116+
117+
# Create realistic package.json
118+
cat > package.json << 'EOF'
119+
{
120+
"name": "test-app",
121+
"version": "1.0.0",
122+
"scripts": {
123+
"start": "react-scripts start",
124+
"build": "react-scripts build"
125+
},
126+
"dependencies": {
127+
"react": "^18.2.0",
128+
"react-dom": "^18.2.0"
129+
},
130+
"devDependencies": {
131+
"@types/react": "^18.0.0"
132+
}
133+
}
134+
EOF
135+
136+
# Create package-lock.json
137+
echo '{"lockfileVersion": 2}' > package-lock.json
138+
139+
# Test setup simulation
140+
node ../bin/setup.js --help
141+
142+
# Verify CLI works in project context
143+
node ../bin/pdc.js check react@19

MANUAL_SETUP.md

Lines changed: 0 additions & 136 deletions
This file was deleted.

0 commit comments

Comments
 (0)