/githubApp

A React Native app built during a bootcamp to show some informations about a github user.

Primary LanguageJavaScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

githubApp

App built using React Native during the Rocketseat's bootcamp.
Explore the docs »

Report Bug · Request Feature

Table of Contents

About The Project

githubApp

This application was made for training purposes during the bootcamp to learn the core concepts of React Native.

This application allows a user to:

  • Search for a github user, and if its successful, saves the user in a list;
  • View the profile and the starred repositories of a user.
  • Delete users from the list.

Built With

Main libraries and CLI tools used to built the project:

To manage the code style and formatting:

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

Install NodeJS:

Install a package manager:

  • yarn: Yarn 1.x (classic) was used in this project.

or

  • npm
npm install npm@latest -g

Installation

The following instructions are for Linux systems.

Disclaimer: I dont have a Macbook to test in iOS, but most of the commands are supposed to be the same.

  1. Clone the repository:
Using ssh:
git clone git@github.com:tukno/githubApp.git

Or using https:
git clone https://github.com/tukno/githubApp.git
  1. Install the project dependencies:
cd githubApp

yarn

or using npm:

cd githubApp

npm install
  1. Well looks like you are done with configuration and ready to code! (I hope so 🎉), run the following commands to execute the metro bundler and deploy the development version of the app in your smartphone or emulator:

For Android:

react-native run-android

For iOS:

react-native run-ios

PS: If the metro bundler exits after running the above command, run react-native start to execute it again in a dedicated terminal window/tab.

PSS: If you get problems check facebook troubleshooting or open an issue ;)

(OPTIONAL): Install Reactotron to debug the app. The instruction for installation and connection to the reactotron desktop client can be found here. The reactotron configuration can be found at src/config/ReactotronConfig.js and it is imported in the src/index.js file.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

David Oliveira - oliveiradavid.dev@gmail.com

Project Link: https://github.com/tukno/githubApp

Acknowledgements