xref: /expo/README.md (revision bb8f4f99)
1<!-- Banner Image -->
2
3<p align="center">
4  <a href="https://expo.io/">
5    <img alt="expo sdk" height="128" src="./style/banner.png">
6    <h1 align="center">Expo</h1>
7  </a>
8</p>
9
10<p align="center">
11   <a aria-label="SDK version" href="https://www.npmjs.com/package/expo" target="_blank">
12    <img alt="Expo SDK version" src="https://img.shields.io/npm/v/expo.svg?style=flat-square&label=SDK&labelColor=000000&color=4630EB" />
13  </a>
14  <a aria-label="Join our forums" href="https://forums.expo.io" target="_blank">
15    <img alt="Forums" src="https://img.shields.io/badge/Ask%20Questions%20-blue.svg?style=flat-square&logo=discourse&logoWidth=15&labelColor=000000&color=4630EB" />
16  </a>
17  <a aria-label="Join our Discord" href="https://discord.gg/4gtbPAdpaE" target="_blank">
18    <img alt="Discord" src="https://img.shields.io/discord/695411232856997968.svg?style=flat-square&labelColor=000000&color=4630EB&logo=discord&logoColor=FFFFFF&label=" />
19  </a>
20  <a aria-label="Expo is free to use" href="https://github.com/expo/expo/blob/master/LICENSE" target="_blank">
21    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-success.svg?style=flat-square&color=33CC12" target="_blank" />
22  </a>
23  <a aria-label="expo downloads" href="http://www.npmtrends.com/expo" target="_blank">
24    <img alt="Downloads" src="https://img.shields.io/npm/dm/expo.svg?style=flat-square&labelColor=gray&color=33CC12&label=Downloads" />
25  </a>
26</p>
27
28<p align="center">
29  <a aria-label="try expo with snack" href="https://snack.expo.io"><b>Try Expo in the Browser</b></a>
30 |
31  <a aria-label="expo documentation" href="https://docs.expo.io">Read the Documentation ��</a>
32</p>
33
34<p>
35  <a aria-label="Follow @expo on Twitter" href="https://twitter.com/intent/follow?screen_name=expo" target="_blank">
36    <img  alt="Twitter: expo" src="https://img.shields.io/twitter/follow/expo.svg?style=flat-square&label=Follow%20%40expo&logo=TWITTER&logoColor=FFFFFF&labelColor=00aced&logoWidth=15&color=lightgray" target="_blank" />
37  </a>
38  <a aria-label="Follow Expo on Medium" href="https://blog.expo.io">
39    <img align="right" alt="Medium: exposition" src="https://img.shields.io/badge/Learn%20more%20on%20our%20blog-lightgray.svg?style=flat-square" target="_blank" />
40  </a>
41</p>
42
43---
44
45- [�� Documentation](#-documentation)
46- [�� Project Layout](#-project-layout)
47- [�� Badges](#-badges)
48- [�� Contributing](#-contributing)
49- [❓ FAQ](#-faq)
50- [�� The Team](#-the-team)
51- [License](#license)
52
53Expo is an open-source platform for making universal native apps that run on Android, iOS, and the web. It includes a universal runtime and libraries that let you build native apps by writing React and JavaScript. This repository is where the Expo client software is developed, and includes the client apps, modules, apps, and more. The [Expo CLI](https://github.com/expo/expo-cli) repository contains the Expo development tools.
54
55[Click here to view the Expo Community Guidelines](https://expo.io/guidelines). Thank you for helping keep the Expo community open and welcoming!
56
57## �� Documentation
58
59<p>Learn about building and deploying universal apps <a aria-label="expo documentation" href="https://docs.expo.io">in our official docs!</a></p>
60
61- [Getting Started](https://docs.expo.io/)
62- [API Reference](https://docs.expo.io/versions/latest/sdk/overview/)
63- [Using Custom Native Modules](https://docs.expo.io/versions/latest/bare/exploring-bare-workflow/)
64
65## �� Project Layout
66
67- [`packages`](/packages) All the source code for the Unimodules, if you want to edit a library or just see how it works this is where you'll find it.
68- [`apps`](/apps) This is where you can find Expo projects which are linked to the development Unimodules. You'll do most of your testing in here.
69- [`docs`](/docs) The source code for **https://docs.expo.io**
70- [`templates`](/templates) The template projects you get when you run `expo start`
71- [`react-native-lab`](/react-native-lab) This is our fork of `react-native`. We keep this very close to the upstream but sometimes need to add quick fixes locally before they can land.
72- [`guides`](/guides) In-depth tutorials for advanced topics like contributing to the client.
73- [`android`](/android) contains the Android project.
74- [`home`](/home) contains the JavaScript source code of the app.
75- [`ios`](/ios) contains the iOS project.
76- [`ios/Exponent.xcworkspace`](/ios) is the Xcode workspace. Always open this instead of `Exponent.xcodeproj` because the workspace also loads the CocoaPods dependencies.
77- [`tools`](/tools) contains build and configuration tools.
78- [`template-files`](/template-files) contains templates for files that require private keys. They are populated using the keys in `template-files/keys.json`.
79- [`template-files/ios/dependencies.json`](/template-files/ios/dependencies.json) specifies the CocoaPods dependencies of the app.
80
81## �� Badges
82
83Let everyone know your app is universal with _Expo_!
84<br/>
85
86[![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-000.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
87
88[![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-4630EB.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
89
90```md
91[![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-000.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
92
93[![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-4630EB.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
94```
95
96## �� Contributing
97
98If you like Expo and want to help make it better then check out our [contributing guide](/CONTRIBUTING.md)! Check out the [Expo CLI repo](http://github.com/expo/expo-cli) to work on the Expo CLI, and various other universal development tools.
99
100## ❓ FAQ
101
102If you have questions about Expo and want answers, then check out our [Frequently Asked Questions](https://docs.expo.io/versions/latest/introduction/faq/)!
103
104If you still have questions you can ask them on our [forums](https://forums.expo.io) or on Twitter [@Expo](https://twitter.com/expo).
105
106## �� The Team
107
108Curious about who makes Expo? Here are our [team members](https://expo.io/about)!
109
110## License
111
112The Expo source code is made available under the [MIT license](LICENSE). Some of the dependencies are licensed differently, with the BSD license, for example.
113