Spring Boot Referral Code Project

How can we invite our friends with using referral code basically? Answer of this question in this repo :)

• Spring Boot
• Exception Handling
• Validation
• H2 Database
• Postman collection

Video Link : https://www.youtube.com/watch?v=TyoF5pbu-3Y

Example Images

API Reference

• check out postman collection under the res folder

Base API: http://localhost:8080

• Get user by username

  GET /api/user/username/{username}

Response:

{
    "id": 1,
    "username": "grkn",
    "name": "gurkan",
    "surname": "surname",
    "mail": "grkn@mail",
    "referralCode": "AJWZN",
    "referredByCode": null
}

• Get all by referral code

  GET /api/user/{code}

Response:

[
    {
        "id": 2,
        "username": "ahmet",
        "referralCode": "TQP2S",
        "name": "ahmet",
        "surname": "a",
        "mail": "ahmet@mail"
    },
    {
        "id": 3,
        "username": "mehmet",
        "referralCode": "G537P",
        "name": "mehmet",
        "surname":  "m",
        "mail":  "mehmet@mail"
    }
]

• Create user using referral code

  POST /api/user

Parameter	Type	Description
username	string	Required. username
name	string	Required. name
referredByCode	string	Required. referralCode
surname	string	surname
mail	string	mail

Request:

{
    "username":"ertm",
    "name":"ertem",
    "referredByCode": "AJWZN"
}

Response:

{
    "id": 2,
    "username": "ertm",
    "name": "ertem",
    "surname": null,
    "mail": null,
    "referralCode": "EFJNM",
    "referredByCode": "AJWZN"
}

Installation

• Clone

  git clone https://github.com/gurkanucar/Spring-Boot-Referral-System.git

• run backend

  cd ./referral-be

  mvn spring-boot:run

• run frontend

  cd ./referral-fe

  npm Install

  npm start