Welcome to Github Explorer Mobile

Project directed to the study of clean architecture applied in a React Native application.

Proposal

It is an application to search for information about users registered on Github, to be able to see their repositories, their gists, their followers and who they are following. You can also view information specific to repositories, gists and other followers.

📌 Sumary

• 👷 Installation
• ⚙️ Test e2e with Detox
• 📂 Architecture
• 📄 License

👷 Installation

You must have NodeJS (>= 10.13.0) and Yarn installed, and then:

git clone https://github.com/rubemfsv/Github-Explorer-Mobile-Clean-Architecture.git

First step:

cd Github-Explorer-Mobile-Clean-Architecture - to access the project folder

Second step:

yarn - to install dependencies

Third step:

yarn start - to start the project

Fourth step:

yarn android or yarn ios - to install the project in the emulator

⚙️ Test e2e with Detox

First Step:

Adjust your emulator inside detox.config.js changing the device avdName

Second Step:

cd android - to access the android folder

Third Step: run ./gradlew assembleAndroidTest

Fourth Step: run yarn detox:debug to execute the tests

📂 Architecture

android/
e2e/
ios/
src/
  data/
    protocols/
    test/
    usecases/
  domain/
    enums/
    errors/
    models/
    test/
    usecases/
  infra/
    http/
    test/
  main/
    config/
    factories/
      http/
      screens/
      usecases/
    routes/
    App.tsx
  presentation/
    assets/
    components/
    screens/
    protocols/
    styles/
    utils/
  validation/
    errors/
    protocols/
    test/
    validators/

🧑‍💻 Contributors

Thanks to these wonderful people who have contributed in this project (emoji key):

Rubem Vasconcelos 🚧💻👀

Joseph Martin 📖

Bryan King Pecho 📖

Vedant 📖

Atharva Salitri 📖

Manvi Haritwal 📖

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Please adhere to and review our Code Of Conduct.