Categorygithub.com/swarnimcodes/bitespeed-backend-task
modulepackage
0.0.0-20240607083052-36049893a344
Repository: https://github.com/swarnimcodes/bitespeed-backend-task.git
Documentation: pkg.go.dev

# README

bbt-golang

Technologies Used

  • Go
  • SQLite

Exposed Endpoints

API Base URL := https://pythonapi.mastersofterp.in/BBT/

  1. GET / Endpoint to check if the API is accessible
  2. GET /customers Endpoint to fetch data for all users in the database
  3. DELETE /clearDB - Requires a valid bearer token to be sent to reset the database
  4. POST /identify Endpoint to identify, categorise, and process an new incoming request.
  • Input:
{
    "email": "[email protected]",
    "phoneNumber": "9090909090"
}
  • Output Format:
{
    "contact": {
        "primaryContactId": 1,
        "emails": ["[email protected]"],
        "phoneNumbers": ["9090909090"],
        "secondaryContactIds": []
    }
}

Build Instructions

  1. Clone the repository

    git clone https://github.com/swarnimcodes/bbt-golang
    
  2. Change Directory

    cd bbt-golang
    
  3. Build

    go build -o bitespeed
    
  4. Run

    ./bitespeed
    
  5. Misc

    Refer to the example.env file for required environment variables

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

create a new Router instance.

# Structs

router struct to hold global and route specific middlewares.

# Type aliases

type alias for a func that takes in a handler and returns a handler.