Giter Site home page Giter Site logo

reddi2mingle's Introduction

Reddi2Mingle

Tinder for Redditors


Team


Table of Contents

  1. Usage
  2. Requirements
  3. Architecture
  4. API
  5. Development
    1. Installing Dependencies
    2. Roadmap
  6. Contributing
  7. Deployment

Usage

Use your reddit account to sign up for the application. Set your preferences and gender to start meeting others with common interests


Requirements

  • React x15.3.0
  • Redux x3.5.2
  • Node x6.2.2
  • Express
  • Neo4j-js
  • MySQL

## Architecture ### High Level Architecture ![](http://i.imgur.com/SKdjwEE.png))

Application Flow

)


API

Client
Purpose URL
Sign-Up /signup
Login /login
Create Password /createPassword
Set Preferences /preferences
Upload Photo /photoUpload
Match with Users /matchmaker
User Profile /profile
Matches /matches
Server
Purpose URL Method Body
Authentication /auth GET -
Authentication /auth/reddit GET -
Authentication /auth/reddit/callback GET -
Get User Info /api/userInfo/?redditId= GET -
Update Password /api/userInfo/updatePassword POST {redditId, password}
Save Preferences /api/userInfo/addPreference POST {redditId, gender, preference}
Save Photo URL /api/userInfo/addPhoto POST {redditId, photo}
Verify Login /api/userInfo/loginCredentials POST {username, password}
Receive Potentials /api/potentials/?redditId= GET -
Create Potentials (?) /api/potentials/createPotentials POST {redditId}
Save Swipe Decision /api/swipe POST {redditId, potentialId, swipeDecision}
Get Matches /api/swipe/matches GET -
API Call Response
/api/userInfo { id, redditId, name, photo, gender, preference, deliveredDownvotes, deliveredUpvotes, receivedDownvotes, receivedUpvotes, commentKarma, postKarma, trophyCount, subreddits: [] }
api/userInfo/loginCredentials {redditId}
api/potentials [{redditId, photo, common_subreddits: []}, redditId, photo, common_subreddits: []}, redditId, photo, common_subreddits: []}]
api/swipes/matches [{redditID, name, photo, common_subreddits}]

Roadmap

View the project roadmap here

Deployment

This has been deployed onto AWS using Docker containers. The backend architecture allows horizontal scaling of the user server to handle higher loads.

reddi2mingle's People

Contributors

tylerbecks avatar jbarbettini avatar n-white avatar christinechou avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

Forkers

ethdevopsw

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.