|
1 | | -# Rspress website |
| 1 | +# React Native Meta Horizon OS Docs |
2 | 2 |
|
3 | | -## Setup |
| 3 | +Documentation site for [React Native Meta Horizon OS](https://github.com/callstack/react-native-meta-horizon-os) - a framework for building Meta Quest VR apps with React Native. |
| 4 | + |
| 5 | +## What is React Native Meta Horizon OS? |
| 6 | + |
| 7 | +React Native Meta Horizon OS allows you to write Meta Quest apps with full support for the platform SDK. Build 2D experiences that feel native to VR using familiar React Native patterns and tooling. |
| 8 | + |
| 9 | +**Key Features:** |
| 10 | + |
| 11 | +- **React Native Core** - Use the same React Native APIs and patterns you already know |
| 12 | +- **Spatial UI** - Build 2D interfaces that work in 3D space with panels, windows, and controls designed for VR |
| 13 | +- **Android Foundation** - Meta Horizon OS is built on AOSP, benefiting from years of React Native Android integration |
| 14 | +- **Hot Reload** - See changes instantly while wearing the headset |
| 15 | +- **Existing Ecosystem** - Many React Native libraries work out of the box |
| 16 | + |
| 17 | +## Documentation |
| 18 | + |
| 19 | +Visit [callstackincubator.github.io/react-native-meta-horizon-os-docs](https://callstackincubator.github.io/react-native-meta-horizon-os-docs) for comprehensive documentation including: |
| 20 | + |
| 21 | +- Getting Started guides |
| 22 | +- Library compatibility information |
| 23 | +- UI/UX patterns for VR |
| 24 | +- Releasing and monetization guides |
| 25 | +- Showcase app examples |
| 26 | + |
| 27 | +## Local Development |
4 | 28 |
|
5 | 29 | Install the dependencies: |
6 | 30 |
|
7 | 31 | ```bash |
8 | 32 | npm install |
9 | 33 | ``` |
10 | 34 |
|
11 | | -## Get started |
12 | | - |
13 | 35 | Start the dev server: |
14 | 36 |
|
15 | 37 | ```bash |
16 | 38 | npm run dev |
17 | 39 | ``` |
18 | 40 |
|
19 | | -Build the website for production: |
| 41 | +Build for production: |
20 | 42 |
|
21 | 43 | ```bash |
22 | 44 | npm run build |
23 | 45 | ``` |
24 | 46 |
|
25 | | -Preview the production build locally: |
| 47 | +Preview the production build: |
26 | 48 |
|
27 | 49 | ```bash |
28 | 50 | npm run preview |
29 | 51 | ``` |
| 52 | + |
| 53 | +## Contributing |
| 54 | + |
| 55 | +Read our [contributing guidelines](CONTRIBUTING.md) to learn how you can contribute with bug reports, documentation improvements, and code. |
| 56 | + |
| 57 | +## Made with ❤️ at Callstack |
| 58 | + |
| 59 | +React Native Meta Horizon OS is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Callstack](https://www.callstack.com/?utm_source=github.com&utm_medium=referral&utm_campaign=react-native-meta-horizon-os&utm_term=readme-with-love) is a group of React and React Native geeks. Contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these technologies or just want to say hi! |
0 commit comments