Categorygithub.com/ahmedkamals/form3
modulepackage
1.0.0
Repository: https://github.com/ahmedkamals/form3.git
Documentation: pkg.go.dev

# README

Form3 CircleCI

license release codecov GolangCI Go Report Card Codacy Badge GoDoc DepShield Badge FOSSA Status

FFFFFFFFFFFFFFFFFFFFFF                                                           333333333333333
F::::::::::::::::::::F                                                          3:::::::::::::::33
F::::::::::::::::::::F                                                          3::::::33333::::::3
FF::::::FFFFFFFFF::::F                                                          3333333     3:::::3
  F:::::F       FFFFFFooooooooooo   rrrrr   rrrrrrrrr      mmmmmmm    mmmmmmm               3:::::3
  F:::::F           oo:::::::::::oo r::::rrr:::::::::r   mm:::::::m  m:::::::mm             3:::::3
  F::::::FFFFFFFFFFo:::::::::::::::or:::::::::::::::::r m::::::::::mm::::::::::m    33333333:::::3
  F:::::::::::::::Fo:::::ooooo:::::orr::::::rrrrr::::::rm::::::::::::::::::::::m    3:::::::::::3
  F:::::::::::::::Fo::::o     o::::o r:::::r     r:::::rm:::::mmm::::::mmm:::::m    33333333:::::3
  F::::::FFFFFFFFFFo::::o     o::::o r:::::r     rrrrrrrm::::m   m::::m   m::::m            3:::::3
  F:::::F          o::::o     o::::o r:::::r            m::::m   m::::m   m::::m            3:::::3
  F:::::F          o::::o     o::::o r:::::r            m::::m   m::::m   m::::m            3:::::3
FF:::::::FF        o:::::ooooo:::::o r:::::r            m::::m   m::::m   m::::m3333333     3:::::3
F::::::::FF        o:::::::::::::::o r:::::r            m::::m   m::::m   m::::m3::::::33333::::::3
F::::::::FF         oo:::::::::::oo  r:::::r            m::::m   m::::m   m::::m3:::::::::::::::33
FFFFFFFFFFF           ooooooooooo    rrrrrrr            mmmmmm   mmmmmm   mmmmmm 333333333333333

Form3 Take Home Exercise - by Ahmed Kamal

Table of Contents

🏎️ Getting Started

Prerequisites

Installation

go get -u github.com/ahmedkamals/form3
cp .env.sample .env

Examples

config := Config{
endpoint: os.Getenv("API_ENDPOINT"),
}

apiClient = NewClient(config, &http.Client{})
ctx := context.Background()

account, err := apiClient.CreateAccount(ctx, form3.Account{})

account, err := apiClient.FetchAccount(ctx, uuid.MustParse("ab6d05a8-8d41-4957-833e-fcc42126351b"), 0)

err := apiClient.DeleteAccount(ctx, uuid.MustParse("ab6d05a8-8d41-4957-833e-fcc42126351b"), 0)

πŸ•ΈοΈ Tests

docker-compose up --abort-on-container-exit --build --remove-orphans api-client

βš“ Git Hooks

In order to set up tests running on each commit do the following steps:

git config --local core.hooksPath .githooks

πŸ‘¨β€πŸ’» Credits

πŸ†“ LICENSE

Form3 is released under MIT license, please refer to the LICENSE.md file.

FOSSA Status

Happy Coding πŸ™‚

Analytics

# Functions

NewClient creates an api Client instance.

# Structs

AccountAttributes of the account.
AccountData represents an account in the form3 org section.
No description provided by the author
No description provided by the author