https://github.com/diegovictor/github-explorer-app

Project developed during the Rocketseat Bootcamp with React Native
https://github.com/diegovictor/github-explorer-app

android app coverage-report editorconfig eslint github-explorer javascript jest js node nodejs prettier react react-native rocketseat ts

Last synced: 29 days ago
JSON representation

Project developed during the Rocketseat Bootcamp with React Native

• Host: GitHub
• URL: https://github.com/diegovictor/github-explorer-app
• Owner: DiegoVictor
• License: mit
• Created: 2019-09-02T04:09:28.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2026-01-15T12:36:05.000Z (2 months ago)
• Last Synced: 2026-01-15T16:54:38.883Z (2 months ago)
• Topics: android, app, coverage-report, editorconfig, eslint, github-explorer, javascript, jest, js, node, nodejs, prettier, react, react-native, rocketseat, ts
• Language: JavaScript
• Homepage:
• Size: 4.31 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# [App] GitHub Explorer

[![AppVeyor](https://img.shields.io/appveyor/build/diegovictor/github-explorer-app?logo=appveyor&style=flat-square)](https://ci.appveyor.com/project/DiegoVictor/github-explorer-app)

[![react-native](https://img.shields.io/badge/react--native-0.81.5-61dafb?style=flat-square&logo=react)](https://reactnative.dev/)

[![styled-components](https://img.shields.io/badge/styled_components-6.3.6-db7b86?style=flat-square&logo=styled-components)](https://styled-components.com/)

[![eslint](https://img.shields.io/badge/eslint-9.39.2-4b32c3?style=flat-square&logo=eslint)](https://eslint.org/)

[![airbnb-style](https://flat.badgen.net/badge/style-guide/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

[![jest](https://img.shields.io/badge/jest-29.7.0-brightgreen?style=flat-square&logo=jest)](https://jestjs.io/)

[![expo](https://img.shields.io/badge/expo-54.0.31-000000?style=flat-square&logo=expo)](https://expo.io/)

[![coverage](https://img.shields.io/codecov/c/github/diegovictor/github-explorer-app?logo=codecov&style=flat-square)](https://app.codecov.io/gh/DiegoVictor/github-explorer-app)

[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/github-explorer-app/main/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)


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

## Table of Contents

- [Screenshots](#screenshots)

- [Installing](#installing)

  - [API](#api)

- [Usage](#usage)

  - [OS](#os)

- [Running the tests](#running-the-tests)

  - [Coverage report](#coverage-report)

# Screenshots

Click to expand.








# Installing

Easy peasy lemon squeezy:

```

$ yarn

```

Or:

```

$ npm install

```

> Was installed and configured the [`eslint`](https://eslint.org/) and [`prettier`](https://prettier.io/) to keep the code clean and patterned.

## API

The application uses the [GitHub's API](https://developer.github.com/v3) 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](https://developer.github.com/v3/#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](https://reactnative.dev/docs/running-on-device).

## OS

This app was tested only with Android through USB connection and [Genymotion](https://www.genymotion.com/) (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](https://jestjs.io/) 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.