Skip to content

Commit ce7e479

Browse files
committed
feat: Add initial implementation of ResourceLoader.js with sample resources
- Created index.html for the main entry point of the application. - Added favicon.ico for the application icon. - Included CSS styles in index-d55f00d0.css for styling the application. - Added sample JavaScript (sample-script.js) and CSS (sample-style.css) files for testing. - Created sample data (sample-data.json) for application features. - Added animated logo (resource-loader-logo.svg) for branding. - Implemented NotFound.vue component for handling 404 errors.
1 parent 22e0b19 commit ce7e479

26 files changed

+3094
-1124
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules
22
docs/package-lock.json
3+
console.log

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ You can directly download the `ResourceLoader.js` file or include it from your p
2020

2121
You can download the `ResourceLoader.js` file directly from this repository.
2222

23+
### Usage
24+
25+
After including ResourceLoader.js in your HTML:
26+
27+
```html
28+
<script src="path/to/ResourceLoader.js"></script>
29+
```
30+
31+
ResourceLoader will be available as a global object `window.ResourceLoader` or simply `ResourceLoader` in your code.
32+
2333
### Demo
2434

2535
Some examples of ResourceLoader in action can be found at [CodePen](https://codepen.io/peterbenoit/pen/gOVLWXZ).

docs/DEPLOYMENT.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# ResourceLoader.js Documentation Site Deployment
2+
3+
## Completed Tasks
4+
5+
- Created a Vue.js documentation site with Tailwind CSS styling
6+
- Implemented interactive examples for all main features
7+
- Set up proper error handling in the examples
8+
- Added sample resources for demonstration
9+
- Created comprehensive API reference documentation
10+
- Fixed template errors in Home.vue page
11+
- Added 404 page for better user experience
12+
- Updated the ResourceLoader.js library comments
13+
- Modified ResourceLoader.js to use window.ResourceLoader to ensure global availability
14+
- Created deployment script for easy Vercel deployment
15+
- Configured Vercel routing and build settings
16+
17+
## Deployment Steps
18+
19+
1. Build the site:
20+
21+
```
22+
cd /Users/peterbenoit/GitHub/ResourceLoader.js/docs
23+
npm run build
24+
```
25+
26+
2. Deploy to Vercel:
27+
28+
```
29+
cd /Users/peterbenoit/GitHub/ResourceLoader.js
30+
vercel --prod
31+
```
32+
33+
Or use the deployment script:
34+
35+
```
36+
cd /Users/peterbenoit/GitHub/ResourceLoader.js/docs
37+
./deploy.sh
38+
```
39+
40+
## Post-Deployment
41+
42+
After deployment:
43+
44+
- Verify all interactive examples work correctly in the live environment
45+
- Check that the ResourceLoader.js file is being properly loaded
46+
- Test on different browsers and devices
47+
- Consider adding Google Analytics for tracking visitor statistics
48+
49+
## Future Improvements
50+
51+
Potential enhancements for the documentation site:
52+
53+
- Add search functionality
54+
- Create a playground for testing custom ResourceLoader configurations
55+
- Add version selection for multiple versions of the library
56+
- Include a community showcase section
57+
- Add downloadable examples as ZIP files

docs/README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,32 @@ This will create a `dist` folder with the built site.
3535

3636
## Deployment
3737

38-
This site is configured for deployment on Vercel. Simply push to your GitHub repository and connect it with Vercel.
38+
This site is configured for deployment on Vercel. You can deploy it in one of several ways:
39+
40+
### Using the Deploy Script
41+
42+
```bash
43+
# Make the script executable (first time only)
44+
chmod +x ./deploy.sh
45+
46+
# Run the deploy script
47+
./deploy.sh
48+
```
49+
50+
### Manual Deployment
51+
52+
```bash
53+
# Build the site
54+
npm run build
55+
56+
# Deploy using Vercel CLI
57+
cd ..
58+
vercel --prod
59+
```
60+
61+
### GitHub Integration
62+
63+
Simply push to your GitHub repository and connect it with Vercel in the Vercel dashboard.
3964

4065
## Structure
4166

docs/deploy.sh

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/bash
2+
3+
# Build the documentation site
4+
echo "Building documentation site..."
5+
npm run build
6+
7+
# Navigate up to the main project directory for deployment
8+
cd ..
9+
10+
# Deploy to Vercel
11+
echo "Deploying to Vercel..."
12+
vercel --prod
13+
14+
echo "Deployment complete!"

0 commit comments

Comments
 (0)