CRM Backend

Status

About the project

The project represent the backend of a Customer Relationship management (CRM) web application. As users interact with app via some UI, our server will support all of the funtionalities via API:

• Getting a list of all customers
• Getting data of a single customer
• Adding a customer
• Updating a customer's information
• Removing a customer

Host

https://morning-shadow-4454.fly.dev/customers

Prerequisite

• Go 1.x

• PostgresSQL (Non-test environment)

• SQLite (Test environment) test.db

• Create a database and a customer table

CREATE TABLE IF NOT EXISTS customers
(
  id SERIAL,
  name TEXT NOT NULL,
  role TEXT NOT NULL,
  email TEXT NOT NULL,
  phone TEXT NOT NULL,
  UNIQUE(name)
)

API docs

• Getting a single customer through a /customers/{id} path

$ curl --location --request GET 'localhost:3000/customers/1'

• Getting all customers through a the /customers path

$ curl --location --request GET 'localhost:3000/customers'

• Creating a customer through a /customers path

$ curl --location --request POST 'localhost:3000/customers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Hoa Nguyen",
    "role": "Software Engineer",
    "email": "nvh0412@gmail.com",
    "phone": "123123123",
    "contacted": false
}'

• Updating a customer through a /customers/{id} path

$ curl --location --request PUT 'localhost:3000/customers/1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Hoa Nguyen",
    "role": "Manager"
}'

• Updating customers in a batch /customers/bulk path

$ curl --location --request PUT 'https://morning-shadow-4454.fly.dev/customers/bulk' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "id": 1,
        "name": "Hoa Nguyen",
        "role": "Software Engineer",
        "email": "nvh0412@gmail.com",
        "phone": "123123123",
        "contacted": false
    },
    {
        "id": 4,
        "name": "Hoa Nguyen 4",
        "role": "Software Engineer",
        "email": "nvh0412@gmail.com",
        "phone": "123123123",
        "contacted": true
    }
]'

• Deleting a customer through a /customers/{id} path

$ curl --location --request DELETE 'localhost:3000/customers/1'

Getting started

1. Setup ENV

Make sure that we've configured these system variables on our dev machine

    APP_DB_USERNAME: ...
    APP_DB_PASSWORD: ...
    APP_DB_NAME: ...
    APP_DB_CONNECTION_STRING: ... // if we set this value, the app will prioritize this value rager than user/pwd envs

2. Get dependencies

    $ cd <project_path>
    $ go get

3. Build project

    $ go build .

4. Run project

    $ ./crm_backend_golang

OR

    $ go run main.go

5. Run test

    $ go test