Rate-Repository-App

A mobile application to search, view, rate, comment GitHub repositories with a single touch.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Rate-Repository-App is a mobile application built on React Native.

Users can search any GitHub repositories they want, view them, rate them, and give comments!

Rate-Repository-App is initially created as a project assignment from the course full stack open.

With some modification and extra features, Rate-Repository-App is easy to use.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow these steps to run the mobile application using simulator or your physical device

Prerequisites

• npm

  Recommend using nvm for Node version management

  nvm

• rate-repository-api

  Rate-Repository-App uses ApolloGraphQL to send requests to rate-repository-api backend server.

  Be sure to set up rate-repository-api first before moving on to install Rate-Repository-App

Installation

• Run in the host machine

1. Clone the repo

   git clone https://github.com/yingtu35/Rate-Repository-App.git

2. Install NPM packages on both backend and frontend folders

   npm install

3. Create a .env file in the root directory and set up the APOLLO_URI environment variable:

   EXPO_PUBLIC_API_APOLLO_URI=YOUR_IP_ADDRESS/graphql

   Check here to see how to find your ip address
4. Start the server

   npm start

(back to top)

(back to top)

-->

Roadmap

• Upload to App store and Google Play
• Enhance features in rate-repository-api (much harder)
• Welcome any new advice!

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Your Name - @YingTu1685990 - yingtu35@gmail.com

Project Link: https://github.com/yingtu35/Rate-Repository-App

(back to top)

Acknowledgments

• Full Stack open
• Expo
• React Navigation
• React Native Paper

(back to top)