MVP: Referral Backend

[eapenzacharias]

Initial Setup with Devise and Devise Token Auth

• Created Rails app in API only mode
• Setup Rubocop Linters
• Created User model
• Set up Devise and Auth Token for User model
• Sign up working in API mode /api/auth [POST]
  • sample request body

    { 
       "email": "user@test.com",
       "password": "1234567",
       "password_confirmation": "1234567",
       "name": "User"
    }
    

• Sign in working in API mode /api/api/auth/sign_in [POST]
  • sample request body

    {
       "email": "user@test.com",
       "password": "1234567"
    }
    

Setup Referral

• Created referral URL. API URL example: http://website.com/api/auth/?referrer=1
• Get all successful referrals of a user. API URL: http://website.com/api/referrals
• Get the details of the user who referred current_user http://website.com/api/referred_by
• Send invite email with the referral URL to an email. API URL: http://website.com/api/send_invite
  • Request Format

     {
         "email": "name@domain.com"
     }