react-native-hackathon-boilerplate

Here in Shawee, we f*cking love React Native!

About the project

🚧 This project is still under construction, we are continually developing this 🚧

This is a React Native application. Actually, this is a boilerplate where we gather the main libraries used in the development of practical solutions for hackathons, totally ready to be modified and used.

This project uses React Native 0.59.3

This project is under construction and in constant change, but we already invite you to contribute to this. You can find more in Contributing section.

Installation

This application needs Node.js installed together with NPM. With this, you will be be able to install react-native-cli and to execute the commands below.

In addition, you need to have all the necessary environment for running native Android, IOS or both platforms.

If you need help setting up your environment, just follow the instructions of this tutorial.

First use the git clone, and then:

$ cd react-native-hackathon-boilerplate

$ npm install i 

// Or you can use Yarn

$ yarn install

// Command to run the application

$ react-native run-android

// Or it can be on iOS devices

$ react-native run-ios

To run tests use npm test or yarn test

Contributing

Guidelines

The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the contributing guidelines for the appropriate sections.

Clone project

Clone this repository

Create a branch

git checkout master from any folder in your local repository

git pull origin master to ensure you have the latest main code

git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

1. Follow the "Installation" instructions
2. Save the files
3. Make your changes

Test the change

2. Run npm test or yarn test from the project root. (This will run Jest Tests)

Push it

1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fixed header logo on Android) to stage and commit your changes

2. git push my-fork-name the-name-of-my-branch

3. Create your PR with the changes