soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

**build(demo): remove GitHub Pages workflow and streamline demo deployment**

Browse source 
### Changes:
- Removed `github-pages.yml` GitHub Actions workflow file.
- Updated `README.md`:
  - Added documentation for `npm run deploy:demo` to deploy the demo to GitHub Pages.
  - Updated the live demo link to reflect the repository's namespace change.
- Added `gh-pages` dependency (v6.3.0) in `package.json`.
- Introduced `deploy:demo` script in `package.json` for demo deployment.

### Purpose:
Streamlined the demo deployment process by removing the dedicated GitHub Pages workflow and replacing it with a manual deployment script (`npm run deploy:demo`). This enhances developer control while maintaining simplicity in deploying updates to the live demo.
This commit is contained in:
David Snelling 2025-06-20 14:23:30 -07:00
parent 982609e001
commit 5cc6f9d683
4 changed files with 202 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -293,6 +293,7 @@ Brainy uses a modern build system that optimizes for both Node.js and browser en
- `npm run build:browser`: Builds the browser-optimized version
- `npm run build:all`: Builds both versions
- `npm run demo`: Builds all versions and starts a demo server
- `npm run deploy:demo`: Deploys the examples directory to GitHub Pages
### Running the Pipeline
@ -972,9 +973,10 @@ the [Cloud Wrapper README](cloud-wrapper/README.md) for detailed configuration i
The repository includes a comprehensive demo that showcases Brainy's main features:
- `examples/demo.html` - A single demo page with animations demonstrating Brainy's features.
- **[Try the live demo](https://soulcraft.github.io/brainy/examples/demo.html)** - Check out the interactive demo on
- **[Try the live demo](https://soulcraft-research.github.io/brainy/examples/demo.html)** - Check out the interactive demo on
GitHub Pages
- Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details)
- To deploy your own version to GitHub Pages, run `npm run deploy:demo`
The demo showcases: