https://github.com/kalegd/digitalbacon

Create 3D websites easily that run on AR, VR, Desktop, and Mobile devices with Digital Bacon. No coding required, but supports an API to create plugins for advanced customizations
https://github.com/kalegd/digitalbacon

3d ar cms digitalbacon javascript threejs vr webgl webxr xr

Last synced: 2 days ago
JSON representation

Create 3D websites easily that run on AR, VR, Desktop, and Mobile devices with Digital Bacon. No coding required, but supports an API to create plugins for advanced customizations

• Host: GitHub
• URL: https://github.com/kalegd/digitalbacon
• Owner: kalegd
• License: mpl-2.0
• Created: 2022-05-18T12:29:27.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2024-10-25T11:52:30.000Z (2 months ago)
• Last Synced: 2024-11-01T09:44:26.247Z (2 months ago)
• Topics: 3d, ar, cms, digitalbacon, javascript, threejs, vr, webgl, webxr, xr
• Language: JavaScript
• Homepage: https://digitalbacon.io
• Size: 63.4 MB
• Stars: 22
• Watchers: 1
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# DigitalBacon

Create 3D websites easily that run on AR, VR, Desktop, and Mobile devices with Digital Bacon. No coding required, but supports an API to create plugins for advanced customizations

            




  

  [![NPM Package](https://img.shields.io/npm/v/digitalbacon)](https://www.npmjs.com/package/digitalbacon) [![Build Size](https://badgen.net/bundlephobia/minzip/digitalbacon)](https://bundlephobia.com/result?p=digitalbacon) [![NPM Downloads](https://img.shields.io/npm/dw/digitalbacon)](https://www.npmtrends.com/digitalbacon) 

[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)


  



### How to use

Go to the [Digital Bacon Editor](https://digitalbacon.io/app) to create a 3D website and then save your project zip file. You can then host your project using the below html snippet (or just [fork this repo](https://github.com/kalegd/DigitalBaconSampleProject) and replace my-project.zip with your project file)

```html

  

    

      {

        "imports": {

          "DigitalBacon": "https://cdn.jsdelivr.net/npm/digitalbacon@latest/build/DigitalBacon.min.js"

        }

      }

    

  

  

    


    

      import { setup } from 'DigitalBacon';


      let params = { projectFilePath: './my-project.zip'};

      setup("my-container-id", params);

    

  

```

### Adding Multi-User Support

You'll need an authUrl and socketUrl tied to a server to handle all the handshaking and management between users. [My Digital Bacon](https://mydigitalbacon.com) offers a free tier that you can use for this purpose, just create an account and add your website's origin as an external project and you'll get the necessary urls to be plugged into your setup parameters like so

```javascript

let params = {

    projectFilePath: './my-project.zip',

    authUrl: '{AUTH_URL}',

    socketUrl: '{WEBSOCKET_URL}',

};

setup("my-container-id", params);

```

### Local Network Testing

If you want to test your changes with another device on your local network, you can run `npm run start-ssl`. Before doing this you'll need to create both cert.pem and key.pem files. Mac Users can generate these files via `openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem`

## Contributors

A special thanks to the following people for taking time to contribute to this project

  

    

      
prajwalbandak
🚇

      
Lauritta
🚇

      
Joel Jose
⚠️

      
Rasesh Kumar Rout
💻

      
kaigidwani
📖