Skip to content

Commit 3a7b11e

Browse files
authored
refactor: sunset package as outlined in RFC 0759 (#933)
* refactor: sunset package as outlined in RFC 0759 see: https://github.com/react-native-community/discussions-and-proposals/blob/main/proposals/0759-react-native-frameworks.md\#the-init-command * docs: add deprecation notice in readme
1 parent a1614e4 commit 3a7b11e

14 files changed

+4783
-4692
lines changed

README.md

+20-116
Original file line numberDiff line numberDiff line change
@@ -3,133 +3,37 @@
33
<p align="center">
44
<a href="https://github.com/expo/examples">
55
<img alt="create-react-native-app" src="./.gh-assets/banner.svg">
6-
<h1 align="center">Create React Native App</h1>
6+
<h1 align="center">⚠️ Deprecated</h1>
77
</a>
88
</p>
99

1010
<!-- Header -->
1111

1212
<p align="center">
13-
<b>The fastest way to create React Native apps</b>
14-
<br />
15-
16-
<p align="center">
17-
<!-- iOS -->
18-
<img alt="Supports Expo iOS" longdesc="Supports Expo iOS" src="https://img.shields.io/badge/iOS-000.svg?style=flat-square&logo=APPLE&labelColor=999999&logoColor=fff" />
19-
<!-- Android -->
20-
<img alt="Supports Expo Android" longdesc="Supports Expo Android" src="https://img.shields.io/badge/Android-000.svg?style=flat-square&logo=ANDROID&labelColor=A4C639&logoColor=fff" />
21-
<!-- Web -->
22-
<img alt="Supports Expo Web" longdesc="Supports Expo Web" src="https://img.shields.io/badge/web-000.svg?style=flat-square&logo=GOOGLE-CHROME&labelColor=4285F4&logoColor=fff" />
23-
</p>
24-
<p align="center">
25-
<a href="https://packagephobia.now.sh/result?p=create-react-native-app">
26-
<img alt="the best way to bootstrap a react native app" longdesc="the best way to create a react native app" src="https://flat.badgen.net/packagephobia/install/create-react-native-app" />
27-
</a>
28-
</p>
29-
30-
</p>
31-
32-
<!-- Body -->
33-
34-
```sh
35-
npx create-react-native-app
36-
```
37-
38-
Once you're up and running with Create React Native App, visit [the tutorial on reactnative.dev](https://reactnative.dev/docs/tutorial) and [the tutorial on expo.dev](https://docs.expo.dev/tutorial/introduction/) for more information on building mobile apps with React.
39-
40-
<p align="center">
41-
<img align="center" alt="Product: demo" src="./.gh-assets/crna.gif" />
13+
<b>It's recommended to use a framework to build apps with React Native, <a href="https://reactnative.dev/docs/environment-setup">learn more</a>.</b>
4214
</p>
4315

44-
## Usage
45-
46-
- `npx create-react-native-app` Create a new native React app.
47-
- `npx crna` Alias for `npx create-react-native-app`.
48-
- `npm run ios` -- (`npx expo run:ios`) Build the iOS App (requires a MacOS computer).
49-
- `npm run android` -- (`npx expo run:android`) Build the Android App.
50-
- `npm run web` -- (`npx expo start --web`) Run the website in your browser.
51-
52-
### Templates
53-
54-
By default you create a [bare workflow React](https://docs.expo.dev/bare/overview/) project with support for iOS, Android, and web. The project comes preconfigured with support for [Expo Modules](https://docs.expo.dev/modules/overview/), an API writing native modules using Swift and Kotlin, and this also makes it possible to use any library in the [Expo SDK](https://docs.expo.dev/versions/latest/).
55-
56-
You can opt to use an example project instead by selecting the "Templates from ..." option. Custom templates can be used with `--template <Example Name or GitHub URL>` option.
57-
58-
- Use an [example](https://github.com/expo/examples): `npx create-react-native-app -t with-typescript`
59-
- Use a custom template: `npx create-react-native-app --template https://github.com/someone/my-react-starter` -- Only works with GitHub repos on the master branch.
60-
- All examples can be modified in the [expo/examples](https://github.com/expo/examples) repo.
61-
62-
## Sections
63-
64-
- [Usage with Expo Go App](#usage-with-expo-go-app)
65-
- [Support and Contact](#support-and-contact)
66-
- [FAQs](#faqs)
67-
- [Contributing](#contributing)
68-
69-
## Usage with Expo Go App
70-
71-
Expo Go enables you to work with all of the [Components and APIs](https://facebook.github.io/react-native/docs/getting-started) in `react-native`, as well as the [JavaScript APIs](https://docs.expo.io/versions/latest) that the are bundled with the Expo app.
16+
<br />
7217

73-
- Download the "Expo Go" app from the Play Store or App Store.
74-
- Start your project with Expo CLI: `npm start`
75-
- Open the project by scanning the QR code in the terminal.
76-
77-
## Support and Contact
78-
79-
If you're having issues with Create React Native App, please make sure:
80-
81-
- The issue is not covered in the [Expo Docs](https://docs.expo.io/versions/latest/)
82-
- There is not already an [open issue](https://github.com/expo/create-react-native-app/issues/) for your particular problem
83-
84-
If you've checked the documentation and currently open issues, please either [open a new GitHub issue](https://github.com/expo/create-react-native-app/issues/new) or ask a question on [Expo Community Discord](https://chat.expo.dev).
85-
86-
## Contributing
87-
88-
Refer to the [Contributing guide](https://github.com/expo/create-react-native-app/blob/main/CONTRIBUTING.md) for more information.
89-
90-
### Attribution
91-
92-
The examples feature was inspired by the `templates` system of [create-next-app](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) by the [Vercel](https://vercel.com/) team.
93-
94-
## Related
95-
96-
CRNA is focused on being the fastest way to bootstrap a React Native app without worrying about the native platforms or bundlers required for developing and shipping apps. Other tools provide both an init script (which is slower) and a suite of other tools that can be used for interacting with the project. CRNA is meant to be used with any of the following tools:
97-
98-
- [Expo CLI](https://docs.expo.dev/more/expo-cli/) by [Expo team](https://expo.dev)
99-
- [Ignite CLI](https://github.com/infinitered/ignite) by [Infinite Red](https://infinite.red/)
100-
- [React Native Community CLI](https://github.com/react-native-community/cli) by members of [the React Native community](https://github.com/orgs/react-native-community/people)
101-
102-
<!-- Footer -->
103-
104-
## Contributors ✨
105-
106-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
107-
[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
108-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
18+
<!-- Body -->
10919

110-
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
20+
## Deprecated
11121

112-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
113-
<!-- prettier-ignore-start -->
114-
<!-- markdownlint-disable -->
115-
<table>
116-
<tr>
117-
<td align="center"><a href="https://twitter.com/baconbrix"><img src="https://avatars1.githubusercontent.com/u/9664363?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Evan Bacon</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=EvanBacon" title="Code">💻</a> <a href="https://github.com/expo/create-react-native-app/commits?author=EvanBacon" title="Documentation">📖</a> <a href="#design-EvanBacon" title="Design">🎨</a> <a href="#maintenance-EvanBacon" title="Maintenance">🚧</a> <a href="https://github.com/expo/create-react-native-app/pulls?q=is%3Apr+reviewed-by%3AEvanBacon" title="Reviewed Pull Requests">👀</a></td>
118-
<td align="center"><a href="https://expo.dev"><img src="https://avatars2.githubusercontent.com/u/90494?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Brent Vatne</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=brentvatne" title="Code">💻</a> <a href="https://github.com/expo/create-react-native-app/commits?author=brentvatne" title="Documentation">📖</a> <a href="https://github.com/expo/create-react-native-app/pulls?q=is%3Apr+reviewed-by%3Abrentvatne" title="Reviewed Pull Requests">👀</a></td>
119-
<td align="center"><a href="http://hamzah"><img src="https://avatars0.githubusercontent.com/u/26879042?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hamza Halilovic</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=hamzahalilovic" title="Code">💻</a></td>
120-
<td align="center"><a href="https://bycedric.com"><img src="https://avatars2.githubusercontent.com/u/1203991?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cedric van Putten</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=byCedric" title="Code">💻</a></td>
121-
<td align="center"><a href="https://twitter.com/VilleImmonen"><img src="https://avatars3.githubusercontent.com/u/497214?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ville Immonen</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=fson" title="Code">💻</a> <a href="https://github.com/expo/create-react-native-app/pulls?q=is%3Apr+reviewed-by%3Afson" title="Reviewed Pull Requests">👀</a></td>
122-
<td align="center"><a href="https://github.com/friederbluemle"><img src="https://avatars0.githubusercontent.com/u/743291?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Frieder Bluemle</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=friederbluemle" title="Code">💻</a></td>
123-
<td align="center"><a href="https://github.com/kbrandwijk"><img src="https://avatars.githubusercontent.com/u/852069?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kim Brandwijk</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=kbrandwijk" title="Code">💻</a></td>
124-
</tr>
125-
<tr>
126-
<td align="center"><a href="https://github.com/srkds"><img src="https://avatars.githubusercontent.com/u/61644078?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nirav</b></sub></a><br /><a href="https://github.com/expo/create-react-native-app/commits?author=srkds" title="Code">💻</a></td>
127-
</tr>
128-
</table>
22+
Create a new Expo project with [create-expo-app](https://github.com/expo/expo/tree/main/packages/create-expo#readme) instead:
12923

130-
<!-- markdownlint-restore -->
131-
<!-- prettier-ignore-end -->
24+
```bash
25+
# Usage for bun, npm, pnpm, and yarn
26+
$ npm create expo
27+
$ bun create expo
28+
$ pnpm create expo
29+
$ yarn create expo
13230

133-
<!-- ALL-CONTRIBUTORS-LIST:END -->
31+
# Output help information with all available options
32+
$ npx create-expo --help
33+
```
13434

135-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
35+
<div align="center">
36+
<br />
37+
with&nbsp;❤️&nbsp;&nbsp;<strong>Expo</strong>
38+
<br />
39+
</div>

0 commit comments

Comments
 (0)