[App] GitHub Explorer

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

Table of Contents

• Screenshots
• Installing
  • API
• Usage
  • Expo
• 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:

$ npm run android

Or:

$ yarn android

For iOS use ios instead of android

For the next time you can just start the server running:

$ yarn start

Or:

$ npm run start

Expo

This project was built using Expo, to know how to run it in any environment see Set up your environment.

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.