Adding compose, docker, pyproject, and other supporting files based o…

…n open-webui

.dockerignore

@@ -0,0 +1,19 @@
+.github
+.DS_Store
+docs
+kubernetes
+node_modules
+/.svelte-kit
+/package
+.env
+.env.*
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+__pycache__
+.idea
+venv
+_old
+uploads
+.ipynb_checkpoints
+**/*.db
+_test

.env.example

@@ -0,0 +1,29 @@
+BASE_URL='http://localhost:3000'
+
+# API Keys
+OPENAI_API_BASE_URL='https://api.openai.com/v1'
+OPENAI_API_KEY=''
+
+# Google Analytics
+GOOGLE_ANALYTICS_TRACKING_ID=''
+
+# Stripe
+STRIPE_API_KEY=''
+STRIPE_WEBHOOK_SECRET=''
+
+# Mailchimp
+MAILCHIMP_API_KEY=''
+MAILCHIMP_LIST_ID=''
+
+# Mailgun
+MAILGUN_API_KEY=''
+MAILGUN_DOMAIN=''
+
+# Sendgrid
+SENDGRID_API_KEY=''
+
+# Twilio
+TWILIO_ACCOUNT_SID=''
+TWILIO_AUTH_TOKEN=''
+TWILIO_FROM_NUMBER=''
+

.eslintignore

@@ -0,0 +1,13 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

.eslintrc.cjs

@@ -0,0 +1,31 @@
+module.exports = {
+ root: true,
+ extends: [
+ 'eslint:recommended',
+ 'plugin:@typescript-eslint/recommended',
+ 'plugin:svelte/recommended',
+ 'plugin:cypress/recommended',
+ 'prettier'
+ ],
+ parser: '@typescript-eslint/parser',
+ plugins: ['@typescript-eslint'],
+ parserOptions: {
+ sourceType: 'module',
+ ecmaVersion: 2020,
+ extraFileExtensions: ['.svelte']
+ },
+ env: {
+ browser: true,
+ es2017: true,
+ node: true
+ },
+ overrides: [
+ {
+ files: ['*.svelte'],
+ parser: 'svelte-eslint-parser',
+ parserOptions: {
+ parser: '@typescript-eslint/parser'
+ }
+ }
+ ]
+};

.gitattributes

@@ -1,2 +1,4 @@
 # Auto detect text files and perform LF normalization
 * text=auto
+*.sh text eol=LF
+

.github/FUNDING.yaml

@@ -0,0 +1 @@
+github: thought-operator

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,66 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+# Bug Report
+
+## Installation Method
+
+[Describe the method you used to install the project, e.g., git clone, Docker, pip, etc.]
+
+## Environment
+
+- **Open WebUI Version:** [e.g., v0.3.11]
+- **Ollama (if applicable):** [e.g., v0.2.0, v0.1.32-rc1]
+
+- **Operating System:** [e.g., Windows 10, macOS Big Sur, Ubuntu 20.04]
+- **Browser (if applicable):** [e.g., Chrome 100.0, Firefox 98.0]
+
+**Confirmation:**
+
+- [ ] I have read and followed all the instructions provided in the README.md.
+- [ ] I am on the latest version of both Open WebUI and Ollama.
+- [ ] I have included the browser console logs.
+- [ ] I have included the Docker container logs.
+- [ ] I have provided the exact steps to reproduce the bug in the "Steps to Reproduce" section below.
+
+## Expected Behavior
+
+[Describe what you expected to happen.]
+
+## Actual Behavior
+
+[Describe what actually happened.]
+
+## Description
+
+**Bug Summary:**
+[Provide a brief but clear summary of the bug]
+
+## Reproduction Details
+
+**Steps to Reproduce:**
+[Outline the steps to reproduce the bug. Be as detailed as possible.]
+
+## Logs and Screenshots
+
+**Browser Console Logs:**
+[Include relevant browser console logs, if applicable]
+
+**Docker Container Logs:**
+[Include relevant Docker container logs, if applicable]
+
+**Screenshots/Screen Recordings (if applicable):**
+[Attach any relevant screenshots to help illustrate the issue]
+
+## Additional Information
+
+[Include any additional details that may help in understanding and reproducing the issue. This could include specific configurations, error messages, or anything else relevant to the bug.]
+
+## Note
+
+If the bug report is incomplete or does not follow the provided instructions, it may not be addressed. Please ensure that you have followed the steps outlined in the README.md and troubleshooting.md documents, and provide all necessary information for us to reproduce and address the issue. Thank you!

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yaml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+ - package-ecosystem: pip
+ directory: '/backend'
+ schedule:
+ interval: weekly
+ target-branch: 'dev'
+ - package-ecosystem: 'github-actions'
+ directory: '/'
+ schedule:
+ # Check for updates to GitHub Actions every week
+ interval: weekly

.github/pull_request_template.md

@@ -0,0 +1,72 @@
+# Pull Request Checklist
+
+## Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/orgs/Thought-Parameters-LLC/discussions) and describe your changes before submitting a pull request
+
+**Before submitting, make sure you've checked the following:**
+
+- [ ] **Target branch:** Please verify that the pull request targets the `dev` branch.
+- [ ] **Description:** Provide a concise description of the changes made in this pull request.
+- [ ] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
+- [ ] **Documentation:** Have you updated relevant documentation [TPNewsletter Docs](https://github.com/Thought-Parameters-LLC/tpnewsletter/docs), or other documentation sources?
+- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
+- [ ] **Testing:** Have you written and run sufficient tests for validating the changes?
+- [ ] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
+- [ ] **Prefix:** To cleary categorize this pull request, prefix the pull request title, using one of the following:
+ - **BREAKING CHANGE**: Significant changes that may affect compatibility
+ - **build**: Changes that affect the build system or external dependencies
+ - **ci**: Changes to our continuous integration processes or workflows
+ - **chore**: Refactor, cleanup, or other non-functional code changes
+ - **docs**: Documentation update or addition
+ - **feat**: Introduces a new feature or enhancement to the codebase
+ - **fix**: Bug fix or error correction
+ - **i18n**: Internationalization or localization changes
+ - **perf**: Performance improvement
+ - **refactor**: Code restructuring for better maintainability, readability, or scalability
+ - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
+ - **test**: Adding missing tests or correcting existing tests
+ - **WIP**: Work in progress, a temporary label for incomplete or ongoing work
+
+## Changelog Entry
+
+### Description
+
+- [Concisely describe the changes made in this pull request, including any relevant motivation and impact (e.g., fixing a bug, adding a feature, or improving performance)]
+
+### Added
+
+- [List any new features, functionalities, or additions]
+
+### Changed
+
+- [List any changes, updates, refactorings, or optimizations]
+
+### Deprecated
+
+- [List any deprecated functionality or features that have been removed]
+
+### Removed
+
+- [List any removed features, files, or functionalities]
+
+### Fixed
+
+- [List any fixes, corrections, or bug fixes]
+
+### Security
+
+- [List any new or updated security-related changes, including vulnerability fixes]
+
+### Breaking Changes
+
+- **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality]
+
+---
+
+### Additional Information
+
+- [Insert any additional context, notes, or explanations for the changes]
+ - [Reference any related issues, commits, or other relevant information]
+
+### Screenshots or Videos
+
+- [Attach any relevant screenshots or videos demonstrating the changes]

.github/workflows/build-release.yaml

@@ -0,0 +1,72 @@
+name: Release
+
+on:
+ push:
+ branches:
+ - main # or whatever branch you want to use
+
+jobs:
+ release:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Check for changes in package.json
+ run: |
+ git diff --cached --diff-filter=d package.json || {
+ echo "No changes to package.json"
+ exit 1
+ }
+
+ - name: Get version number from package.json
+ id: get_version
+ run: |
+ VERSION=$(jq -r '.version' package.json)
+ echo "::set-output name=version::$VERSION"
+
+ - name: Extract latest CHANGELOG entry
+ id: changelog
+ run: |
+ CHANGELOG_CONTENT=$(awk 'BEGIN {print_section=0;} /^## \[/ {if (print_section == 0) {print_section=1;} else {exit;}} print_section {print;}' CHANGELOG.md)
+ CHANGELOG_ESCAPED=$(echo "$CHANGELOG_CONTENT" | sed ':a;N;$!ba;s/\n/%0A/g')
+ echo "Extracted latest release notes from CHANGELOG.md:" 
+ echo -e "$CHANGELOG_CONTENT" 
+ echo "::set-output name=content::$CHANGELOG_ESCAPED"
+
+ - name: Create GitHub release
+ uses: actions/github-script@v7
+ with:
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ script: |
+ const changelog = `${{ steps.changelog.outputs.content }}`;
+ const release = await github.rest.repos.createRelease({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ tag_name: `v${{ steps.get_version.outputs.version }}`,
+ name: `v${{ steps.get_version.outputs.version }}`,
+ body: changelog,
+ })
+ console.log(`Created release ${release.data.html_url}`)
+
+ - name: Upload package to GitHub release
+ uses: actions/upload-artifact@v4
+ with:
+ name: package
+ path: |
+ .
+ !.git
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Trigger Docker build workflow
+ uses: actions/github-script@v7
+ with:
+ script: |
+ github.rest.actions.createWorkflowDispatch({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ workflow_id: 'docker-build.yaml',
+ ref: 'v${{ steps.get_version.outputs.version }}',
+ })