Stargazers Viewer App ⭐️

📖 Table of Contents

Table of Contents

1. ➤ About The Project
2. ➤ Getting Started
3. ➤ Authors

📝 About The Project

StarGazers Viewer App is a mobile application that allows you to search for a GitHub user and it's repository and view its stargazers. Built using React Native and TypeScript, the application uses the GitHub API with graphql to fetch the stargazers of a repository.

📖 Getting Started

Via GitHub Desktop clone this repository then to run the app, you need to have Node.js v20.12.2 or higher installed on your system and Android Studio or XCode installed in your system.

Warning

To run this project locally you need to create an .env file in the root of the project directory with following variables:

API_URL = https://api.github.com
API_KEY = ${YOUR_GITHUB_TOKEN}

You can create a personal Github token here. Make sure to add Read access to followers, starring, and watching as permission.

To run it locally, follow these steps:

• Navigate to the project folder.
• Run the command npm install to install all the necessary dependencies.
• On ios, cd ios && pod install && cd..
• Run the command npx react-native start to start the app. From the cli now select the system to run.

The app will install in your emulator/device.

📜 Authors

Emanuele Dall'Ara