https://github.com/atlinx/nuxt-aframe
Template for using Nuxt, AFrame, ThreeJS, Typescript, and TailwindCSS together. 🅰️
https://github.com/atlinx/nuxt-aframe
Last synced: 11 months ago
JSON representation
Template for using Nuxt, AFrame, ThreeJS, Typescript, and TailwindCSS together. 🅰️
- Host: GitHub
- URL: https://github.com/atlinx/nuxt-aframe
- Owner: Atlinx
- Created: 2023-06-06T13:41:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-07T16:07:54.000Z (about 3 years ago)
- Last Synced: 2025-06-02T21:54:02.035Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 7.36 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nuxt AFrame 🅰️
Template for building AFrame experiences using Nuxt, AFrame, ThreeJS, Typescript, and TailwindCSS. The demo is hosted on Github Pages.
The demo website is hosted on [https://atlinx.github.io/nuxt-aframe](https://atlinx.github.io/nuxt-aframe).
## Developing
### Prerequisites
- Make sure you have NodeJS installed.
- Clone this repository
- Run
```bash
npm i
```
### Hosting a local server
Run
```bash
npm run dev
```
### Hosting a local server live
If you need to test the website from different devices, it's best to host the server live through a proxy. This repo has scripts to host from ngrok.
#### Using ngrok
Make sure you have [ngrok](https://ngrok.com/product) installed and have registered an ngrok account and setup your ngrok token.
Run
```bash
npm run dev
```
In a separate terminal, run
```bash
npm run ngrok
```
> **NOTE:**
>
> We have a separate command for ngrok because it doesn't display any output when its
> used with the "concurrently" npm command.
### Building the website
Run
```bash
npm run build
```