Add docs/, a starter script, update instructions

Author: robwillup

Dockerfile.server ContainerfileDockerfile.server renamed to Containerfile

@@ -3,17 +3,20 @@ A Go chat app
 
 ## Running the App
 
+You can run the app directly on your machine if you have Postgres and RabbitMQ.
+
+Otherwise, you can run the containerized version with:
+
 Clone this repo:
 
 ```shell
 git clone [email protected]:robwillup/gochatty.git
 cd gochatty
 ```
 
-Build and run the `podman-compose` file:
+Run the following commands:
 
 ```shell
-podman-compose -f podman-compose.yml build
-
-podman-compose -f podman-compose.yml up -d
+chmod +x scripts/run.sh
+./script/run.sh
 ```

README.md

@@ -0,0 +1,49 @@
+# Go Challenge - Browser-based chat app
+
+## Description
+
+This project is designed to test your `knowledge of backend web technologies`, specifically in `Go` and assess your
+ability to create backend products with `attention to detail`, `standards`, and `reusability`.
+
+## Assignment
+
+The goal of this exercise is to create a simple browser-based chat application using Go.
+
+This application should allow several users to talk in a chatroom and also to get stock quotes from an API using a
+specific command.
+
+## Mandatory Features
+
+* Allow registered users to log in and talk to other users in a chatroom.
+* Allow users to post messages as commands into the chatroom with the following format **/stock=stock_code**.
+* Create a **decoupled** bot that will call an API using the stock_code as a parameter
+    * (https://stooq.com/q/l/?s=aapl.us&f=sd2t2ohlcv&h&e=csv) here *aapl.us* is the stock_code.
+* The bot should parse the received CSV file and then it should send a message back into the chatroom using a message
+  broker like RabbitMQ. The message will be a stock quote using the following format:
+  "APPL.US quote is $93.42 per share". The post owner will be the bot.
+* Have the chat message ordered by their timestamps and show only the last 50 messages.
+* Unit tests
+
+## Bonus (Optional)
+
+* Have more than one chatroom.
+* Handle messages that are not understood or any exceptions raised within the bot.
+
+## Considerations
+
+* We will open two browser windows and log in with 2 different users to test the functionalities.
+* The stock command won't be saved on the database as a post.
+* The project is totally focused on the backend; please, have the frontend as simple as you can.
+* Keep confidential information secure.
+* Pay attention if your chat is consuming too many resources.
+* Keep your code versioned with Git locally.
+* Feel free to use small helper libraries.
+
+## Deliverables
+
+When you finish the assignment upload your project to your GitHub and share the repo link with your initial contact
+via email.
+Indicate which, if any, of the bonus tasks you completed.
+
+If you didn't manage to finish everything, please tell us which parts you completed.
+

docs/requirements.md

@@ -6,7 +6,7 @@ import (
 	"github.com/golang-jwt/jwt/v5"
 )
 
-var jwtKey = []byte("secret_key") // TODO: Use a secure value.
+var jwtKey = []byte("secret_key") // TODO: Use real key from vault/env vars.
 
 func GenerateJWT(username string) (string, error) {
 	claims := &jwt.RegisteredClaims{

internal/auth/jwt.go

@@ -23,7 +23,7 @@ services:
   server:
     build:
       context: .
-      dockerfile: Dockerfile.server
+      dockerfile: Containerfile
     restart: always
     environment:
       DATABASE_URL: postgres://gochattyuser:gochattypass@db:5432/gochattydb?sslmode=disable

podman-compose.yml

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+podman-compose -f podman-compose.yml build
+podman-compose -f podman-compose.yml up -d
+
+open frontend/index.html