jennifertakagi / github-favorites

An application to show the user's favorites repositories on GitHub

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

GitHub Favorites

Discover user's favorites repositories from GitHub!
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

About The Project

Product Name Screen Shot

Discover user's favorites repositories from GitHub.

Features:

  • Input the user you are curious about
  • Discover his favorites repositories from GitHub

Built With

Getting Started

Prerequisites

  • npm

    npm install npm@latest -g
  • yarn

    npm install --global yarn
  • EXPO - optional (if you prefer download Xcode and Cocoapods)

  • Xcode

  • COCOAPODS

Installation

  1. Clone the repo
    git clone https://github.com/jennifertakagi/github-favorites.git
  2. Install packages on api, web and mobile folders
    yarn | npm install
  3. In case you're using Macbook, please run the line above on ios folder:
    pod instal
  4. Run the local environment on api
    yarn start | npm run dev:start
  5. Run the local environment on web
    yarn start | npm run start
  6. Run the local environment on mobile
    yarn ios | android

Roadmap

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

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

Jennifer Takagi - @jennitakagi

Acknowledgements

About

An application to show the user's favorites repositories on GitHub

License:MIT License


Languages

Language:JavaScript 57.5%Language:Java 13.7%Language:Objective-C 9.7%Language:Ruby 8.3%Language:CSS 5.4%Language:Starlark 4.2%Language:HTML 1.1%