Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thetechie/create-react-primitive-app

Create react cross platform apps with no build configuration. Mixture of create-react-app and create-react-native-app
https://github.com/thetechie/create-react-primitive-app

create-react-app create-react-native-app react react-native react-primitives

Last synced: 24 days ago
JSON representation

Create react cross platform apps with no build configuration. Mixture of create-react-app and create-react-native-app

Awesome Lists containing this project

README 

        
# Create React Primitive App

[![npm version](https://badge.fury.io/js/create-react-primitive-app.svg)](https://badge.fury.io/js/create-react-primitive-app)



Create React cross-platform apps with no build configuration.



* [Getting Started](#getting-started)

* [User Guide](https://github.com/theTechie/create-react-primitive-app/blob/master/react-primitive-scripts/template/README.md)



Once you're up and running with Create React Primitive App, visit [this tutorial](https://facebook.github.io/react-native/docs/tutorial.html) for more information on building apps with React Native.



## Quick Overview



Make sure you have Node v6 or later installed. No Xcode or Android Studio installation is required.



```sh

$ npm install -g create-react-primitive-app

$ create-react-primitive-app my-app

$ cd my-app/

$ npm start

```



Install the [Expo](https://expo.io) app on your iOS or Android phone, and use the QR code in the terminal to open your app. Find the QR scanner on the Projects tab of the app. When you're ready to share your project with others (for example, by deploying to an app store), read the [Sharing & Deployment](https://github.com/theTechie/create-react-primitive-app/blob/master/react-primitive-scripts/template/README.md#sharing-deployment) section of the User Guide.



Create React Primitive App allows you to work with all of the [Components and APIs](https://facebook.github.io/react-native/docs/getting-started.html) in React Native, as well as most of the [JavaScript APIs](https://docs.expo.io/versions/latest/sdk/index.html) that the Expo App provides.



## Sections



* [Getting Started](#getting-started)

* [Philosophy](#philosophy)

* [Support and Contact](#support-and-contact)

* [FAQs](#faqs)

* [Contributing](#contributing)



## Getting Started



### Installation



Install it once globally:



```sh

$ npm install -g create-react-primitive-app

  # or

$ yarn global add create-react-primitive-app

```

### Creating an App



To create a new app, run:



```sh

$ create-react-primitive-app my-app

$ cd my-app

```



This will create a directory called `my-app` inside the current working directory. Inside `my-app`, this will generate the initial project structure and install all of its dependencies.



If you're familiar with React Native already, you won't find any `ios` or `android` directories in this project, just JavaScript. Once this installation is done, there are some commands you can run in the project directory:



#### `npm start`



Runs your app in development mode with an interactive prompt. To run it without a prompt, use the `--no-interactive` flag.



Open it in the [Expo app](https://expo.io) on your phone to view it. It will reload if you save edits to your files, and you will see build errors and logs in the terminal.



#### `npm test`



Runs the [jest](https://github.com/facebook/jest) test runner on your tests.



#### `npm run ios`



Like `npm start`, but also attempts to open your app in the iOS Simulator if you're on a Mac and have it installed.



#### `npm run android`



Like `npm start`, but also attempts to open your app on a connected Android device or emulator. Requires an installation of Android build tools (see [React Native docs](https://facebook.github.io/react-native/docs/getting-started.html) for detailed setup).



#### `npm run eject`



This will start the process of "ejecting" from Create React Primitive App's build scripts. You'll be asked a couple of questions about how you'd like to build your project.



**Warning:** Running eject is a **permanent** action. Please use a version control system, such as git, so you can revert back if necessary. An ejected app will require you to have an [Xcode and/or Android Studio environment](https://facebook.github.io/react-native/docs/getting-started.html) set up.



## Philosophy



* **Minimal "Time to Hello World"**: Create React Primitive App should reduce the setup time it takes to try building a mobile app to the absolute minimum, ideally on par with React web development (especially as seen with [Create React App](https://github.com/facebookincubator/create-react-app)).

* **Develop on Your Device**: It should be easy to develop on a physical device when you want to test how your app feels and responds to inputs.

* **One Build Tool**: If you just want to get started with React Native, you shouldn't need to install Xcode, Android Studio, NDKs, or mess with environment variables.

* **No Lock-In**: You can always "eject" to your own build setup if you need to write custom native code or modify how your app is built.



## Support and Contact



If you're having issues with Create React Primitive App, please make sure:



* The issue is not covered in the [Getting Started](https://github.com/theTechie/create-react-primitive-app#getting-started) or [User Guide](https://github.com/theTechie/create-react-primitive-app/blob/master/react-primitive-scripts/template/README.md) documentation

* There is not already an [open issue](https://github.com/theTechie/create-react-primitive-app/issues) for your particular problem



If you've checked the documentation and currently open issues, please either open a new GitHub issue, [find @gaganblr on Twitter](https://twitter.com/gaganblr), **Please do not DM or email project maintainers directly**, as it's very important that support takes place in public locations where others can benefit from the conversation.



## FAQs



### What API specification should I be looking at while developing?



Apps made with Create React Primitive App support everything in the Components and APIs sections of the [React Native Documentation](https://facebook.github.io/react-native/docs/getting-started.html).



Apps made with Create React Primitive App also support most of the JavaScript-to-Native APIs provided by the [Expo SDK](https://docs.expo.io/versions/latest/sdk/index.html), since they are loaded by the Expo app.



### What are the limitations of Create React Primitive App?



The main limitation of a Create React Primitive App project is that it must be written in pure JavaScript and not have any dependencies which rely on custom native code (i.e. ones which require running `react-native link` to work). This allows the projects to load directly on a phone without native compilation, and also means that it's not necessary to install or use Android Studio or Xcode.



### What if I want to write custom native code for my app?



If you're sure that you need custom native code, please read the [ejecting guide](https://github.com/theTechie/create-react-primitive-app/blob/master/EJECTING.md).



### How do I get my app into the Play Store/App Store?



If you need to build IPAs and APKs for publishing to the App Store and/or Play Store, you can either eject (see above guide) and build them yourself using Xcode and Android Studio, or you can use a service like [Expo's standalone app builds](https://docs.expo.io/versions/v13.0.0/guides/building-standalone-apps.html) to publish your pure JS app.



## Contributing



Contributions will be licensed under the [3-clause BSD license](https://github.com/theTechie/create-react-primitive-app/blob/master/LICENSE). Please fork the repository, perform your work on a feature branch, and submit a pull request to this repository's master branch from your fork's branch.



For details about setting up a development environment and testing your changes, please see [CONTRIBUTING.md](https://github.com/theTechie/create-react-primitive-app/blob/master/CONTRIBUTING.md).