added docker compose

Author: jha-captech

.env.local

@@ -0,0 +1,7 @@
+DATABASE_CONTAINER_NAME=go-api-tech-challenge-db
+DATABASE_NAME=goAPITechChallengeDB
+DATABASE_USER=user
+DATABASE_PASSWORD=password
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+

.gitignore

@@ -18,4 +18,6 @@ employees.db
 # Dependency directories (remove the comment below to include it)
 # vendor/
 .DS_Store
-app.env
+app.env
+
+**/.env

internal/database/database_postgres_setup.sql renamed to database_postgres_setup.sql

@@ -11,7 +11,7 @@ CREATE TABLE "users" (
 );
 
 -- Create blog table
-CREATE TABLE blogs (
+CREATE TABLE "blogs" (
     id BIGSERIAL PRIMARY KEY,
     author_id INTEGER NOT NULL,
     title TEXT NOT NULL,

db_seed.sql

@@ -0,0 +1,59 @@
+DROP TABLE IF EXISTS person_course;
+DROP TABLE IF EXISTS course;
+DROP TABLE IF EXISTS person;
+
+-- person
+CREATE TABLE person
+(
+    id         SERIAL PRIMARY KEY,
+    first_name TEXT                                          NOT NULL,
+    last_name  TEXT                                          NOT NULL,
+    type       TEXT CHECK (type IN ('professor', 'student')) NOT NULL,
+    age        INTEGER                                       NOT NULL
+);
+
+INSERT INTO person (first_name, last_name, type, age)
+VALUES ('Steve', 'Jobs', 'professor', 56),
+       ('Jeff', 'Bezos', 'professor', 60),
+       ('Larry', 'Page', 'student', 51),
+       ('Bill', 'Gates', 'student', 67),
+       ('Elon', 'Musk', 'student', 52);
+
+-- course
+CREATE TABLE course
+(
+    id   SERIAL PRIMARY KEY,
+    name TEXT NOT NULL
+);
+
+INSERT INTO course (name)
+VALUES ('Programming'),
+       ('Databases'),
+       ('UI Design');
+
+-- person_course
+CREATE TABLE person_course
+(
+    person_id INTEGER NOT NULL,
+    course_id INTEGER NOT NULL,
+    PRIMARY KEY (person_id, course_id),
+    FOREIGN KEY (person_id) REFERENCES person (id),
+    FOREIGN KEY (course_id) REFERENCES course (id)
+);
+
+INSERT INTO person_course (person_id, course_id)
+VALUES (1, 1),
+       (1, 2),
+       (1, 3),
+       (2, 1),
+       (2, 2),
+       (2, 3),
+       (3, 1),
+       (3, 2),
+       (3, 3),
+       (4, 1),
+       (4, 2),
+       (4, 3),
+       (5, 1),
+       (5, 2),
+       (5, 3);

docker-compose.yaml

@@ -0,0 +1,31 @@
+services:
+  postgres:
+    image: postgres:alpine
+    container_name: ${DATABASE_CONTAINER_NAME}
+    restart: always
+    networks:
+      - app
+    env_file:
+      - .env
+    environment:
+      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
+      POSTGRES_USER: ${DATABASE_USER}
+      POSTGRES_DB: ${DATABASE_NAME}
+      PGUSER: postgres
+    ports:
+      - "5432:5432"
+    volumes:
+      - ./database_postgres_setup.sql:/docker-entrypoint-initdb.d/init.sql
+      - postgres-db:/var/lib/postgresql/data
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -d ${DATABASE_NAME} -U ${DATABASE_USER}" ]
+      interval: 5s
+      start_period: 1s
+      timeout: 5s
+      retries: 5
+
+volumes:
+  postgres-db:
+
+networks:
+  app:

docs/1-Technical-Setup.md

@@ -71,6 +71,9 @@ colima --version
 
 # install docker with homebrew
 brew install docker
+
+# install docker-compose with homebrew
+brew install docker-compose
 ```
 
 Once installed, you can start and stop colima using the following command:
@@ -83,12 +86,33 @@ colima start
 colima stop
 ```
 
+> ---
+>
+>  If you run into an error such as:
+>
+>
+> `Cannot connect to the Docker daemon at unix:///var/run/docker.sock. 
+> Is the docker daemon running?`
+>
+> please reference this
+> [help article](https://github.com/abiosoft/colima/blob/main/docs/FAQ.md#cannot-connect-to-the-docker-daemon-at-unixvarrundockersock-is-the-docker-daemon-running).
+>
+> ---
+
+> ---
+>
 > If you run into an error such as:
 >
->`Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?`
+> `docker: 'compose' is not a docker command.`
 >
->please reference
-> this [help article](https://github.com/abiosoft/colima/blob/main/docs/FAQ.md#cannot-connect-to-the-docker-daemon-at-unixvarrundockersock-is-the-docker-daemon-running).
+> add the following JSON to your `~/.docker/config.json file.`
+> ```json
+> "cliPluginsExtraDirs": [
+>     "/opt/homebrew/lib/docker/cli-plugins"
+> ]
+> ```
+>
+> ---
 
 ### DBeaver
 
@@ -137,46 +161,30 @@ Once your repository is cloned locally, you are all set to move on to the next s
 
 ## Database Setup
 
-In order to initialize the database, the following setup will be required.
-
-- First, ensure that you have installed and configured Podman Desktop correctly. Then, open a
-  terminal and run the following commands to start a podman instance:
+To reduce developer friction, we have provided a docker-compose file that will create a PostgreSQL
+databse instance for you. To start this container, we first need to create a `.env` file. To do
+this, running the following command to make a copy of the `.env.local` file:
 
-```
-podman machine init
-podman machine start
+```bash
+# copy the .env.local file to .env
+cp .env.local .env
 ```
 
-- Next, pull the PostgreSQL image by running the following command:
+Next you can modify the username and password in the `.env` file if you would like to change it from
+the default. We have already added the `.env` file to the `.gitignore` file so that it will not be
+pushed to the repository.
 
-```
-podman pull docker.io/library/postgres:latest
-```
+To start the database, run the following command:
 
-- You are then able to create a Podman container to store the database in. Run the following command
-  in your terminal:
-
-```
-podman run -d --name PostgresServer -e POSTGRES_USER=user -e POSTGRES_PASSWORD=goChallenge -e POSTGRES_DB=blogs -p 5432:5432 docker.io/library/postgres:latest
+```bash
+# start the database
+docker command up
 ```
 
-At this point, you will notice in Podman Desktop that a container has been created and running on
-port 5432.
-
-In order to initialize the database and provide default data, you will need to complete the
-following steps. Make sure that your podman container is up and running prior to completing these
-steps.
+Now that the database is running, we can connect to it using DBeaver.
 
 - First, open DBeaver and add a new connection, specifying PostgreSQL as the database type. Next,
-  make sure that the host, port, database, and credentials match as below
-
-```
-Host: localhost
-Port: 5432
-Database: blogs
-Username: user
-Password: goChallenge
-```
+  make sure that the host, port, database, and credentials match the values in the `.env` file.
 
 > ---
 >
@@ -185,25 +193,25 @@ Password: goChallenge
 >
 > ---
 
-- Once you have connected to the database, open a new sql script. Then, copy and paste the SQL
-  commands into the sql script from the `database_postgres_setup.sql` file under the `/database`
-  directory. At this point, you have now initialized your database and are ready to continue.
+- Once you have connected to the database, confirm you can see the `comments` database and the
+  tables
+  `blogs` and `users`.
 
 ## Create Go Module and Install Necessary Libraries
 
 To create your go project, open a terminal in the root project directory and run the following
 command, replacing `[name]` with your name.
 
-```
+```bash
 go mod init github.com/[name]/blog
 ```
 
 Next, run the following commands that will install the required libraries for the tech challenge.
 
 ```bash
 go get github.com/caarlos0/env/v11
+go get github.com/jackc/pgx/v5/stdlib
 go get github.com/swaggo/http-swagger
-go get github
 go install github.com/swaggo/swag/cmd/swag@latest
 ```