/SumoChickn

A React Native/Redux application for sending challenges to your friends

Primary LanguageJavaScript

SumoChickn

Challenge the World.

Team

Table of Contents

  1. Usage
  2. Dependencies
  3. Development
    1. Installing Dependencies
    2. Project Information
    3. Authentication/Authorization
    4. Client Design
  4. Contributing

Usage

General use

  1. Log in with Facebook
  2. Create and send a challenge on the Create Challenge view.
  3. View your own challenges on the My Challenges view.
  4. Take on challenges sent to you and take a picture of yourself attempting it.
  5. Vote on the validity of other people's challenge attempts on the Proof view.
  6. If the validity of your challenge has been decided by votes, check out the Leaderboard view to see your changes in points.

Description

SumoChickn is a interactive social challenge app that allows your to send challenges to other users around the world. As the user, you can accept a challenge and take a photo of yourself completing it. The photo will be uploaded to the application's newsfeed view where other users can vote on whether the challenge was a success(sumo) or if the challenge was a fail(chicken). Accumulate sumo points to increase your position on the leaderboard!

##Dependencies

###Client Dependencies

  • react-native 0.22.0
  • react-native-dropdown 0.0.6
  • react-native-router-flux 3.1.3
  • react-native-uploader 0.0.9
  • react-native-scrollable-tab-view 0.4.0
  • react-facebook-login 1.0.3
  • react-redux 3.3.1
  • redux 3.3.1
  • redux-thunk 2.0.1
  • immutable 3.7.6
  • isomorphic fetch 2.2.1
  • node-xml2json 1.0.0
  • redux-logger 2.6.1
  • react-native-camera git+https://github.com/lwansbrough/react-native-camera.git

##Installing Dependencies

Navigate to the root directory:

npm install

Project Information

Authentication/Authorization

Authentication is implemented with an npm module for React Native called react-facebook-login. The module provides a React native component that wraps the Facebook SDK login button. When triggered, the component will ask for the user's facebook login information and when the user is authenticated, they will be authorized to use the application. The user's facebook name will be saved into a mySQL database as a user.

Client Design

The Front-end was built in React native with four(4) scenes using the react-native-flux-router module. The scenes are:

TYPE KEY COMPONENT INITIAL
replace signUp LoginAuth TRUE
replace myChallenges myChallenges FALSE
replace createChallenges SendChallenges FALSE
replace camera CameraConnect FALSE

Server Design

SumoChickn uses a mySQL database paired with a Node/Express Server deployed through Digital Ocean. The back-end architecture files are available here.

Contributing

See CONTRIBUTING.md for contribution guidelines.