GithubHelp home page GithubHelp logo

hhy5277 / hackerbuzz-reactnative Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rciesielczuk/hackerbuzz-reactnative

0.0 1.0 0.0 4.08 MB

A Hacker News Reader built in React Native for iOS and Android

License: MIT License

Python 1.28% Java 4.59% JavaScript 82.89% Objective-C 10.92% Ruby 0.33%

hackerbuzz-reactnative's Introduction

HackerBuzz-ReactNative

Over the past few months, I've been working on a side project to gain an understanding of the React Native workflow. I decided to create a Hacker News reader using Y Combinator's API.

Available for iOS on the App Store and Android on the Google Play Store

Setup

  1. Clone the repo
  2. $ cd HackerBuzz-ReactNative
  3. Run either $ yarn install or $ npm install

I used the Facebook Audience Network in order to display advertisements every 20 stories. As a result, you need to make sure that the SDK is properly installed or else the project won't build.

iOS

  1. Make sure that cocoapods are installed
    • $ sudo gem install cocoapods
  2. $ pod install
  3. Open HackerBuzz.xcworkspace
  4. Modify jsCodeLocation to point to your IP address in AppDelegate.m
  5. If you wish display ads, make sure that you create a placement within the Facebook Developer console or else they won't appear.
  6. Run via XCode or $ react-native run-ios

Android

  1. Build the Android project
  2. Add the Facebook SDK to the project as per these instructions
  3. If you wish display ads, make sure that you create a placement within the Facebook Developer console or else they won't appear.
  4. Run via Android Studio

Testing

The project currently contains test for the actions and reducers within /js/__tests__/. Mocks are located within js/__mocks__/ In order to execute these tests, run $ npm test.

Current Test Coverage

Scripts

  • $ npm bundle-ios - Bundle code for an iOS release build
  • $ npm bundle-android - Bundle code for an Android release build
  • $ npm test - Run unit tests
  • $ lint-fix - Run linter

Future Work

Settings

  • Light Theme
  • Specify Font Size

Contributing and License

Issues

Feel free to submit issues and enhancement requests.

Contributing

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

License

Released under the MIT License. Check LICENSE.md for more info.

Donate

Any support would be highly appreciated! ๐Ÿš€ ๐ŸŒ•

  • BTC: 1LCurQW9j7rP7uJYki2uW8RGFDJPujdvEt
  • ETH: 0x6350726EfE25205ef3AE88f054a16d40091725B6
  • LTC: LPvPMmqzBSDEjUmJcv2bXNUuc6cUWLnfoq

hackerbuzz-reactnative's People

Contributors

punksta avatar rciesielczuk avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.