Sure, here is an updated version of the README with some sample curl commands for the available APIs:

---

Trader-Go

Trader-Go is a web application that interacts with a MySQL database to manage stock trading data. This README provides instructions for setting up and running the project, including building Docker containers, initializing the database, and configuring SSL/TLS.

Table of Contents

1. Project Overview
2. Prerequisites
3. Setup
4. Running the Application
5. Database Initialization
6. SSL/TLS Configuration
7. Usage
8. Troubleshooting
9. License
10. Sample API Usage

Project Overview

Trader-Go is designed to handle stock trading data, including users, stocks, and orders. It uses a MySQL database for storage and a Go application for business logic and API endpoints.

Prerequisites

Before you begin, ensure you have the following installed:

• Docker
• Docker Compose
• Go (for local development)
• MySQL (for local development or using Docker)
• OpenSSL (for generating SSL certificates)

Setup

1. Clone the Repository

   git clone https://github.com/yourusername/trader-go.git
   cd trader-go

2. Build the Docker Containers

   • Dockerfile.db: Sets up the MySQL database.
   • Dockerfile.go: Sets up the Go application.

   docker-compose build

3. Configure Docker Compose

   Ensure your docker-compose.yml is correctly configured. Example configuration:

   version: '3'
   services:
     db:
       build:
         context: .
         dockerfile: Dockerfile.db
       ports:
         - "3306:3306"
       environment:
         MYSQL_ROOT_PASSWORD: password1
         MYSQL_DATABASE: trader_go
         MYSQL_USER: tradergo
         MYSQL_PASSWORD: password1
       volumes:
         - db-data:/var/lib/mysql
         - ./init.sql:/docker-entrypoint-initdb.d/init.sql
   
     app:
       build:
         context: .
         dockerfile: Dockerfile.go
       ports:
         - "10000:10000"
       depends_on:
         - db
       volumes:
         - ./resources:/app/resources
   
   volumes:
     db-data:

4. Start the Application

   docker-compose up

Running the Application

Once the containers are up and running, you can access the Trader-Go application at https://localhost:10000. The application will interact with the MySQL database to handle data related to users, stocks, and orders.

Database Initialization

The init.sql file is used to initialize the MySQL database with the required schema and sample data. It is located in the project root and automatically executed by the Docker container on startup.

init.sql Contents

-- Initialize the database with schema and data

-- Create the database if it doesn't exist
CREATE DATABASE IF NOT EXISTS trader_go;

-- Switch to the newly created database
USE trader_go;

-- Create the user if it doesn't exist
CREATE USER IF NOT EXISTS 'tradergo'@'%' IDENTIFIED BY 'password1';

-- Grant all privileges on the database to the user
GRANT ALL PRIVILEGES ON trader_go.* TO 'tradergo'@'%' WITH GRANT OPTION;

-- Flush privileges to apply changes
FLUSH PRIVILEGES;

-- Create the tables
CREATE TABLE IF NOT EXISTS users (
  id INT AUTO_INCREMENT PRIMARY KEY,
  username VARCHAR(30) NOT NULL
);

CREATE TABLE IF NOT EXISTS stocks (
  id INT AUTO_INCREMENT PRIMARY KEY,
  symbol VARCHAR(6) DEFAULT NULL,
  name VARCHAR(50) DEFAULT NULL,
  price DECIMAL(13,2) DEFAULT NULL,
  total_shares INT DEFAULT NULL
);

CREATE TABLE IF NOT EXISTS orders (
  id INT AUTO_INCREMENT PRIMARY KEY,
  user_id INT NOT NULL,
  stock_id INT NOT NULL,
  shares INT DEFAULT NULL,
  FOREIGN KEY (user_id) REFERENCES users(id),
  FOREIGN KEY (stock_id) REFERENCES stocks(id)
);

-- Insert sample data
INSERT IGNORE INTO users (username) VALUES 
('ktumy'), ('btumy'), ('etumy'), ('mtumy'), ('jdoe'), ('janedoe'), ('johnnyquest');

INSERT IGNORE INTO stocks (symbol, name, price, total_shares) VALUES 
('AAPL', 'Apple, Inc', 128.91, 200000000),
('F', 'Ford Motor Company', 10.17, 390000000),
('Nike', 'Nike, Inc', 140.72, 2000000),
('TSLA', 'Tesla, Inc', 826.57, 20000000),
('T', 'AT&T, Inc', 29.17, 20000000),
('TUMY', 'Tumy | Tech, Inc', 29.17, 20000000),
('ACME', 'Acme, Corp', 1000.17, 20000000),
('MyCorp', 'My, Corp', 500000.16, 20000000);

INSERT IGNORE INTO orders (user_id, stock_id, shares) VALUES 
(1, 1, 500),
(1, 2, 500),
(2, 1, 500),
(2, 2, 500),
(2, 7, 500);

SSL/TLS Configuration

To enable SSL/TLS for secure connections, you need to generate and configure SSL certificates.

Generating SSL Certificates

1. Generate the Private Key and Certificate

   Navigate to the resources directory:

   cd resources

   Use OpenSSL to generate the private key and certificate:

   openssl req -newkey rsa:2048 -nodes -keyout app.trader-go.io.key -x509 -days 365 -out app.trader-go.io.crt

   • -newkey rsa:2048: Generates a new RSA key of 2048 bits.
   • -nodes: Skips the option to secure the key with a passphrase.
   • -keyout: Specifies the file to save the private key.
   • -x509: Specifies that a self-signed certificate is created.
   • -days 365: Sets the validity period of the certificate to 365 days.
   • -out: Specifies the file to save the certificate.

2. Configure the Application to Use SSL

   Ensure that your Go application is configured to use the generated SSL files. Update your Go application's configuration to reference:

   • resources/app.trader-go.io.crt (Certificate file)
   • resources/app.trader-go.io.key (Key file)

Sample API Usage

Create a User

curl -X POST -H "Content-Type: application/json" -d '{"username": "newuser"}' https://localhost:10000/users

Get All Users

curl -X GET https://localhost:10000/users

Create a Stock

curl -X POST -H "Content-Type: application/json" -d '{"symbol": "GOOGL", "name": "Alphabet Inc", "price": 2750.00, "total_shares": 1000000}' https://localhost:10000/stocks

Get All Stocks

curl -X GET https://localhost:10000/stocks

Search Stocks by Symbol or Name

curl -X GET "https://localhost:10000/search/stocks?query=AAPL"

Create an Order

curl -X POST -H "Content-Type: application/json" -d '{"userid": 1, "stockid": 1, "shares": 10}' https://localhost:10000/orders

Get All Orders

curl -X GET https://localhost:10000/orders

Troubleshooting

• Database Connection Issues: Ensure that the MySQL container is up and running. Check the docker-compose logs db for any errors.
• Table Not Found: If tables are missing, ensure that the init.sql script was executed correctly. You can manually execute it within the MySQL container if needed.
• Permission Errors: Verify that the root user in MySQL has the necessary permissions to create users and grant privileges.
• SSL/TLS Errors: Ensure that the SSL certificate files are correctly placed in the resources directory and properly referenced in your application configuration.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

---