dev-ops-and-chill

Developer Setup Guide

Welcome to the project! This document will guide you through the process of setting up your local development environment.

Prerequisites

Before you start, ensure you have the following installed:

1. VS Code
   We recommend using Visual Studio Code (VS Code) for development, as it provides excellent support for Docker, C#, and remote environments. Download VS Code from here.

2. VS Code Remote-Containers Extension
   Install the Remote-Containers extension in VS Code to develop directly inside the containerized environment. You can find it in the VS Code marketplace.

3. Docker
   Docker is required for running the remote development environment. Install Docker from here.

Setting Up the Development Environment

1. Clone the Repository
   First, clone the project repository to your local machine:

   git clone https://github.com/your-org/your-repository.git
   

2. Open the Project in VS Code
   Open the project folder in VS Code. If you have the Remote-Containers extension installed, you will be prompted to open the project inside the container. Select “Reopen in Container” to work directly inside the containerized environment.

   VS Code Remote-Containers Documentation

3. Running the Application
   Once inside the remote container, open the Run and Debug tab:

   Select “Haiku Launch (console)” and start debugging

4. Debugging
   VS Code provides excellent debugging support for C#. Set breakpoints and use the VS Code debug panel to inspect and run the application directly from the editor.

   VS Code Debugging C#

Environment Variables

To run the haiku generator successfully, define the following environment variables:

• OUTPUT_PATH: The full path to the generated HTML file. Example: ./docs/index.html
• TWEET_PATH: The path to the file containing the latest scraped tweet. Example: ./src/scraper/latest-tweet.txt
• OPENAI_API_KEY: Your OpenAI API key used for generating haikus and metadata.

You can configure these in your shell environment, a .env file, or via VS Code’s launch.json.

Running the Twitter Scraper (Node.js)

The src/scraper directory contains a Node.js app that uses Puppeteer to scrape Trump’s latest post from X (Twitter).

To install and run:

cd src/scraper
npm install
npm start

This will write the most recent tweet text to src/scraper/latest-tweet.txt, which is used as input to the haiku generator.

Additional Resources

• Docker Documentation
• VS Code Documentation
• C# Development in VS Code
• Docker for VS Code
• OPSEC Guidelines

This site is open source. Improve this page.