DiegoVictor / github-explorer-app

Project developed during the Rocketseat Bootcamp with React Native

[App] GitHub Explorer

This app allow to users track github's users and see their starred projects.

Table of Contents

• Screenshots
• Installing
  • API
• Usage
  • OS
• Running the tests
  • Coverage report

Screenshots

Click to expand.

Installing

Easy peasy lemon squeezy:

$ yarn

Or:

$ npm install

Was installed and configured the eslint and prettier to keep the code clean and patterned.

API

The application uses the GitHub's API and it has some rate limitations, if suddenly the app stops to show data take a look at this first!

See more on about Rate limiting

Usage

The first build must be through USB connection, so connect your device (or just open your emulator) and run:

$ yarn react-native run-android

Or

$ npx react-native run-android

In the next times you can just run the Metro Bundler server:

$ yarn start

Or:

$ npm run start

See for more information in Running On Device.

OS

This app was tested only with Android through USB connection and Genymotion (Emulator), is strongly recommended to use the same operational system, but of course you can use an emulator or a real device connected through wifi or USB.

Running the tests

Jest was the choice to test the app, to run:

$ yarn test

Or:

$ npm run test

Coverage report

You can see the coverage report inside tests/coverage. They are automatically created after the tests run.