Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 4.7 KB

README.md

File metadata and controls

111 lines (72 loc) · 4.7 KB
Raw

GitHub-Explorer

A simple react-native App that allows to see all the repositories and organizations that some GitHub user has.

                        alt text             alt text

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Build Files

You can also get only the file to run directly on your device:

  • Android .apk file: download
  • iOS file: SOON!

Prerequisites

Setting-up environment

  • To run the iOS App, you might be in a Apple environment, and also have the Xcode installed. You can download Xcode here.

  • To run the Android App, you might have Android-Studio installed. You can download Android-Studio here.

  • Also, if you want to use a different emulator to run the Android App, I strongly recommend you to use Genymotion.

Installing

If you already have the Node.js and npm installed, you can skip the step below.

Installing Node.js and npm

To run the App, you'll need to have the Node.js and npm installed on your machine, if you don't have Node.js and npm installed yet, you can follow the following steps to install both:

  • Installing Node.js and npm on macOS and Windows environment: here.
  • Installing Node.js and npm on Ubuntu environment: here.

Installing react-native cli

You'll need to have the react-native cli installed on your machine, that will make possible to run the App.

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

Running the App

Cloning the repository

$ git clone https://github.com/steniowagner/github-explorer && cd github-explorer

Installing project dependencies

$ npm install

After cloning the repository and enter on the directory, you just need to run one of the following commands, depending on which platform you want to see the App running:

Running the iOS App

$ react-native run-ios

Running the Android App

$ react-native run-android

Coding Style

This App follow the air-bnb JavaScript style guide, you can learn more about this here.

Built With

  • React-Native - A framework for building native apps using React
  • API-Sauce - A lib to request/response API requests
  • Reactotron - A macOS, Windows, and Linux app for inspecting your React JS and React Native apps.
  • Babel - The compiler for writing next generation JavaScript
  • ESLint - The pluggable linting utility for JavaScript and JSX
  • ApeTool - Create all the required sizes of Icons and Splashscreens for your app instantly for all major platforms

Contributing

Feel free to contribute to this project with new features or any improvements that you think that is relevant!

License

GitHubExplorer is provided under the MIT License.

The MIT License (MIT)
Copyright (c) 2017 Stenio Wagner
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.