Skip to content

Latest commit

 

History

History
205 lines (156 loc) · 6.29 KB

README.md

File metadata and controls

205 lines (156 loc) · 6.29 KB
Raw

Coffeehouse

Coffeehouse is an example/reference service for keeping records of your favorite coffee recipes.

Common Tasks

Task is used to run common tasks that are used in development. To see all the tasks available, run task -l.

Install Task

If you do not have Task, commands can be viewed from the Taskfile

Running the Application

Create a file called docker.env in the root of the project with the following content:

touch docker.env

docker.env file contents

COFFEEHOUSE_DB_PASSWORD=password
COFFEEHOUSE_DB_HOST=db
COFFEEHOUSE_DB_TLS=true
COFFEEHOUSE_NATS_URL=nats://nats:4222
COFFEEHOUSE_REDIS_URL=redis:6379
COFFEEHOUSE_LISTEN_ADDR=0.0.0.0:8080

To run the application and see log output, run the following command:

task local-dev

The server should now be running and listening on port 8080.

Sending requests to the server

The file endpoints.http contains example requests that can be sent to the server. You can use the REST Client extension in Visual Studio Code to send the requests.

Sequence diagram for common workflows

sequenceDiagram
    participant User
    participant CoffeehouseAPI
    participant PostgresDB

    User->>CoffeehouseAPI: Sign up with user data
    CoffeehouseAPI->>PostgresDB: Insert user data
    PostgresDB-->>CoffeehouseAPI: User account created
    CoffeehouseAPI-->>User: User account created successfully

    User->>CoffeehouseAPI: Create a recipe
    CoffeehouseAPI->>PostgresDB: Insert recipe data
    PostgresDB-->>CoffeehouseAPI: Recipe created
    CoffeehouseAPI-->>User: Recipe created successfully

    User->>CoffeehouseAPI: Get the newly created recipe
    CoffeehouseAPI->>PostgresDB: Query for new recipe
    PostgresDB-->>CoffeehouseAPI: Return new recipe data
    CoffeehouseAPI-->>User: Display new recipe

    User->>CoffeehouseAPI: Get a list of recipes
    CoffeehouseAPI->>PostgresDB: Query for list of recipes
    PostgresDB-->>CoffeehouseAPI: Return list of recipes
    CoffeehouseAPI-->>User: Display list of recipes

    User->>CoffeehouseAPI: Save recipe
    CoffeehouseAPI->>PostgresDB: Update user saved recipes
    PostgresDB-->>CoffeehouseAPI: Recipe saved successfully
    CoffeehouseAPI-->>User: Recipe saved to user account

    User->>CoffeehouseAPI: Get user details
    CoffeehouseAPI->>PostgresDB: Query for user details including saved recipes
    PostgresDB-->>CoffeehouseAPI: Return user details and saved recipes
    CoffeehouseAPI-->>User: Display user details and saved recipes
Loading

Example curl requests

The curl requests below include all calls needed to run the workflows above.

Create a user

curl --request POST \
  --url http://localhost:8080/v1/users \
  --header 'content-type: application/json' \
  --data '{"name": "sample","email": "sample@email.com","password": "password"}'

Create a recipe

curl --request POST \
  --url http://localhost:8080/v1/recipes \
  --header 'content-type: application/json' \
  --data '{"recipe_name": "sample","brew_method": "chemex","coffee_weight": 20.0,"weight_unit": "g","grind_size": 21,"water_weight": 500.0,"water_unit": "g"}'

Get the recipe

curl --request GET \
  --url http://localhost:8080/v1/recipes/1

Save the recipe for the user

curl --request POST \
  --url http://localhost:8080/v1/save-recipe \
  --header 'content-type: application/json' \
  --data '{"user_id": 1,"recipe_id": 1}'

Get the user which will include the saved recipes

curl --request GET \
  --url http://localhost:8080/v1/users/1

Running the Command Line Digital Sign

digitalsign

The command line digital sign subscribes to the NATS topic and prints the recipe out. To run the command line digital sign, run the following command:

task digitalsign

Create a new recipe and the command line digital sign will display the recipe in the table.

Kubernetes

If you have a running Kubernetes cluster, you can deploy the application using the Kubernetes deployment files. The deployment files are located in the k8s directory.

To deploy the application, run the following command:

kubectl apply -f k8s

This will create the necessary deployments, services, and secrets for the application. The application will be accessible through the service coffeehouse.

k9s

You will need to run the migrate task to create the database schema:

kubectl port-forward deployment/db 5432:5432

# separate terminal
task migrate

To access the application, you can port-forward the service to your local machine:

kubectl port-forward service/coffeehouse 8080:8080

The server should now be accessible on port 8080.

The Kubernetes deployment is not meant for production use and is only for demonstration purposes.

Features

Coffeehouse includes the following features:

  • RESTful API: Example CRUD operations for a coffee recipe
  • Redis Caching: Example caching of the coffee recipe
  • SQLC and PostgreSQL: Uses SQLC for type-safe Go from SQL and PostgreSQL for the database
  • Example unit and integration tests for the server
  • Docker Compose for running the server, database, nats, and redis
  • Kubernetes deployment files for the server, database, nats, and redis
  • Logging using Zap
  • Pub/Sub using NATS
  • Command line digital sign that subscribes to the NATS topic
  • Taskfile for running common tasks that are used in development

Directory

coffeehouse
│   routes.go - all the routes for the server
│   server.go - where the server struct is defined   
│   main.go - entry point of the application
|___cmd
│   │   digitalsign - command line digital sign
|___cache - caching interface
│   │   cache.go
|___|
|   |___redis - redis implementation
│   │   recipe.go
└───database
│   │   database.go
└───logger
│   │   logger.go

Code Generation

Coffeehouse uses sqlc for generating type-safe Go from SQL. It uses moq for mocking interfaces for use in testing.

References