Merge branch 'main' of https://github.com/chasecee/pi-dashboard

README.md

@@ -4,120 +4,101 @@ My Project
 
 ## Project Overview
 
-This project is a Next.js application that provides various features, including a chat interface, weather information, image generation, and more. It utilizes several APIs and libraries to deliver a comprehensive user experience.
+This project is a Next.js application that provides various features, including a chat interface, weather information, image generation, and more. It utilizes a range of technologies and APIs to deliver a comprehensive user experience.
 
 ## Features
 
-- Chat functionality
-- Weather information
-- Image generation using Dalle-2 API
-- Blob storage and display
-- Quotable and random fact generation
-- Logbook and connection status
+- Chat interface with OpenAI API integration
+- Weather information retrieval and display
+- Image generation using the DALL-E API
+- Blob storage and display functionality
+- Quotation and random fact retrieval
+- Logbook and connection status monitoring
 
 ## File Structure
 
 ```
-.
-├── tsconfig.json
-├── next.config.js
-├── public
-│   ├── next.svg
-│   ├── vercel.svg
-│   └── img
-│       └── da.jpg
-├── package-lock.json
-├── vercel.json-off
-├── README.md
-├── package.json
-├── postcss.config.js
-├── app
-│   ├── page.tsx
-│   ├── layout.tsx
-│   ├── api
-│   │   ├── quotes
-│   │   │   └── route.js
-│   │   ├── randomFact
-│   │   │   └── route.js
-│   │   ├── chat
-│   │   │   └── route.js
-│   │   ├── weather
-│   │   │   └── route.js
-│   │   ├── list-blobs
-│   │   │   └── route.js
-│   │   ├── get-colors
-│   │   │   └── route.js
-│   │   ├── image
-│   │   │   └── route.js
-│   │   └── store-and-display-image
-│   │       └── route.js
-│   ├── chat
-│   │   └── page.tsx
-│   ├── utils
-│   │   ├── generateAndSave.js
-│   │   ├── fetchWeatherData.js
-│   │   ├── openai.ts
-│   │   └── fetchWeatherSummary.js
-│   ├── components
-│   │   ├── HaNode.jsx
-│   │   ├── FactComponent.tsx
-│   │   ├── DalleImage.jsx
-│   │   ├── WeatherTemp.jsx
-│   │   ├── ConnectionStatus.tsx
-│   │   ├── LatestImage.jsx
-│   │   ├── Quotable.jsx
-│   │   ├── Logbook.jsx
-│   │   ├── BlobList.jsx
-│   │   ├── Clock.jsx
-│   │   ├── Date.jsx
-│   │   └── Weather.jsx
-│   ├── globals.css
-│   ├── favicon.ico
-│   └── blob
-│       └── page.tsx
-└── generate_readme.py
+tsconfig.json
+next.config.js
+public/
+  next.svg
+  vercel.svg
+  img/
+    da.jpg
+package-lock.json
+vercel.json-off
+README.md
+package.json
+postcss.config.js
+app/
+  page.tsx
+  layout.tsx
+  api/
+    quotes/
+      route.js
+    randomFact/
+      route.js
+    chat/
+      route.js
+    weather/
+      route.js
+    list-blobs/
+      route.js
+    get-colors/
+      route.js
+    image/
+      route.js
+    store-and-display-image/
+      route.js
+  chat/
+    page.tsx
+  utils/
+    generateAndSave.js
+    fetchWeatherData.js
+    openai.ts
+    fetchWeatherSummary.js
+  components/
+    HaNode.jsx
+    FactComponent.tsx
+    DalleImage.jsx
+    WeatherTemp.jsx
+    ConnectionStatus.tsx
+    LatestImage.jsx
+    Quotable.jsx
+    Logbook.jsx
+    BlobList.jsx
+    Clock.jsx
+    Date.jsx
+    Weather.jsx
+  blob/
+    page.tsx
+  globals.css
+  favicon.ico
 ```
 
 ## Installation
 
 To set up the project, follow these steps:
 
-1. Clone the repository:
-   ```
-   git clone https://github.com/yourusername/your-project.git
-   ```
-2. Navigate to the project directory:
-   ```
-   cd your-project
-   ```
-3. Install the dependencies:
-   ```
-   npm install
-   ```
-4. Start the development server:
-   ```
-   npm run dev
-   ```
-5. Open your web browser and visit `http://localhost:3000` to access the application.
+1. Clone the repository: `git clone https://github.com/your-username/your-project.git`
+2. Navigate to the project directory: `cd your-project`
+3. Install dependencies: `npm install`
+4. Start the development server: `npm run dev`
 
 ## Usage
 
-The application provides the following features:
-
-- Chat functionality: Interact with the chat interface to have conversations.
-- Weather information: Check the current weather conditions for a specific location.
-- Image generation: Use the Dalle-2 API to generate images based on your input.
-- Blob storage and display: Manage and display images stored in the blob storage.
-- Quotable and random fact generation: Get inspirational quotes or random facts.
-- Logbook and connection status: Track the application's connection status and log events.
-
-Explore the different sections of the application to utilize these features.
+Once the development server is running, you can access the application in your web browser at `http://localhost:3000`. The various features can be accessed through the provided user interface.
 
 ## Contributing
 
 If you would like to contribute to this project, please follow these guidelines:
 
-1. Fork the repository.
-2. Create a new branch for your feature or bug fix.
-3. Make your changes and ensure the code is properly formatted and tested.
-4. Submit a pull
+1. Fork the repository
+2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature`
+3. Make your changes and commit them: `git commit -am 'Add some feature'`
+4. Push your branch to GitHub: `git push origin feature/your-feature`
+5. Open a pull request, and describe your changes in detail
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).