2018-08-10 02:15:49 +03:00
|
|
|
# Spoke (alpha)
|
|
|
|
|
|
|
|
|
|
Easily create custom 3D environments for [Mozilla Hubs](https://hubs.mozilla.com).
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
New to Spoke? Check out the [Getting Started Guide](https://github.com/MozillaReality/Spoke/wiki/Getting-Started)
|
2018-06-06 08:55:27 +03:00
|
|
|
|
2018-06-08 23:20:36 +03:00
|
|
|
## Installation
|
2018-06-06 08:55:27 +03:00
|
|
|
|
2018-06-08 23:20:36 +03:00
|
|
|
```
|
2018-07-31 00:01:59 +03:00
|
|
|
npm install -g spoke-test-cli
|
2018-06-08 23:20:36 +03:00
|
|
|
```
|
|
|
|
|
|
2018-07-31 00:29:42 +03:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
cd my-project
|
|
|
|
|
spoke
|
|
|
|
|
```
|
|
|
|
|
|
2018-07-06 20:30:31 +03:00
|
|
|
## Development
|
2018-06-08 23:20:36 +03:00
|
|
|
|
2018-06-06 08:55:27 +03:00
|
|
|
```
|
2018-07-06 20:30:31 +03:00
|
|
|
npm run dev
|
2018-06-08 23:20:36 +03:00
|
|
|
```
|
|
|
|
|
|
2018-07-31 01:00:25 +03:00
|
|
|
Then open https://localhost:9090.
|
2018-07-25 07:08:00 +03:00
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
|
|
|
|
|
|
Parts of this project are derived from the [three.js editor](https://threejs.org/editor/)
|
2018-07-25 07:11:28 +03:00
|
|
|
with thanks to [Mr.doob](https://github.com/mrdoob) and three.js' many contributors.
|
2018-07-25 07:08:00 +03:00
|
|
|
|
|
|
|
|
See the [LICENSE](LICENSE) for details.
|
