futurice/pepperoni-sample-app

Name: pepperoni-sample-app

Owner: Futurice

Description: Sample app to demonstrate how to create a React Native app with Pepperoni starter kit (http://getpepperoni.com)

Created: 2017-04-04 10:02:31.0

Updated: 2018-05-05 21:07:34.0

Pushed: 2017-06-27 09:58:31.0

Homepage: null

Size: 46678

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Pepperoni - Empowered by Futurice

React Native Sample App based on Pepperoni Starter Kit

Build Status React Native Sponsored License

React Native Starter Kit is a part of Pepperoni, a framework for kickstarting digital product development.

How to create your React Native using Pepperoni
Step 1: Mirror Pepperoni starter kit repository

To build your own app on top of the Pepperoni Starter Kit, you will need to create a new repository and mirror the Pepperoni repository, you can follow these instructions about how to mirror a repository.

Step 2: Change the app name

By default, the app name is Pepperoni App Template, so in order to give a name to your application, just run the script ./support/rename.sh YourAppName. Once the script is executed you will need to change the title of the app in the navigation bar, simply go to src/navigator/Navigation.js and search for “Pepperoni App Template” and replace that title with your app name.

Other useful information
Start the application in iOS simulator
act-native run-ios
Start the application in Android simulator

(If using the stock emulator, the emulator must be running)

act-native run-android
Run unit tests
m test
Run tests every time code changes
m run test:watch
Generate code coverage report
m run coverage

Read the Testing guide for more information about writing tests.

Debugging

For standard debugging select Debug JS Remotely from the React Native Development context menu (To open the context menu, press CMD+D in iOS or D+D in Android). This will open a new Chrome tab under http://localhost:8081/debugger-ui and prints all actions to the console.

For advanced debugging under macOS we suggest using the standalone React Native Debugger, which is based on the official debugger of React Native. It includes the React Inspector and Redux DevTools so you can inspect React views and get a detailed history of the Redux state.

You can install it via brew and run it as a standalone app:

ew update && brew cask install react-native-debugger

Note: Make sure you close all active chrome debugger tabs and then restart the debugger from the React Native Development context menu.

Deployment

Read the Deployment guide to learn how to deploy the application to test devices, app stores, and how to use Code Push to push updates to your users immediately.

License

MIT License

Credits

The original project was initially motivated by Snowflake, a React Native boilerplate by Barton Hammond. It shares some features and design principles for Pepperoni, but it wasn't the right fit for our needs. At this time Snowflake is more mature, so if you like Pepperoni but didn't agree with something we are doing, you should check it out to see if it's a good fit for your app.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.