Create documentation & update README.md

Author: gnmyt

README.md

@@ -3,55 +3,42 @@
   TigerBug
 </h1>
 
-<p align="center"><strong>The open source bug reporting system designed specifically for video game development teams.</strong></p>
+<p align="center"><strong>A simple bug tracker built for game developers.</strong></p>
 
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
-[![Node.js](https://img.shields.io/badge/node.js-22+-green.svg)](https://nodejs.org)
-[![SQLite](https://img.shields.io/badge/database-SQLite-003B57.svg)](https://sqlite.org)
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![MIT License][license-shield]][license-url]
 
----
-
-### 💡 Why we built TigerBug
+## Why we built this
 
-As game developers ourselves, we were frustrated with existing bug tracking solutions.
-Enterprise solutions like Jira felt overwhelming for our use cases, while simple tools lacked the features we needed.
-We couldn't find a tool that:
+We needed a bug tracker that didn't suck for game development. Most tools are built for web apps and don't handle the stuff we actually need - like sharing save files, crash logs, and screenshots. 
 
-- **Understood our game development workflows** - Most tools were built for web development, not games
-- **Made it easy to share gameplay footage and save files** - Essential for reproducing game bugs
-- **Gather feedback from players** - We needed a way to involve our community in bug reporting
+Jira is overkill and expensive. GitHub Issues is too basic. Everything else either costs too much or doesn't understand game development workflows.
 
-So we built TigerBug - our custom-made solution that combines the best of everything we wanted in a bug tracker,
-tailored specifically for game development teams.
+So we built our own. It's got the basics done right:
 
-### 🎯 Core Features
-
-- **🏗️ Project-based Organization** - Organize bugs by game project
-- **🔐 Flexible Authentication** - Email/password or OAuth (Google, GitHub) - your choice
-- **💬 Rich Commenting System** - Thread discussions with file attachments for screenshots, logs, and saves
-- **👍 Community Voting** - Let your team and players upvote the most critical issues
-- **📧 Smart Notifications** - Stay informed via email when issues change or receive comments
-- **📎 File Attachments** - Upload crash logs, screenshots, save files, and reproduction steps
+- Project organization (one tracker per game)
+- File uploads for screenshots, logs, save files, whatever
+- Comments and discussions on issues  
+- Voting so you know what actually matters
+- Email notifications that don't spam you
+- OAuth login (Google, Discord) or just email/password
 
 ![Screenshot of detail view](https://i.imgur.com/aWbUzUP.png)
 
-### 🐛 Issue Tracking for Games
-
-Every bug report in TigerBug is designed to capture the full context of the issue:
+## How it works
 
-- **Clear titles and descriptions** help everyone understand the issue
-- **Priority through voting** - let the team highlight what breaks the game experience
-- **Rich discussions** with threaded comments and file uploads
+Each bug report has a title, description, priority level, and status. People can comment with attachments, vote on what's important, and discuss solutions. Nothing fancy, just the stuff you actually need.
 
 ![Screenshot of new issue](https://i.imgur.com/Ak2Qupw.png)
 
 ![Screenshot of kanban view](https://i.imgur.com/5MME37b.png)
 
-### 🐳 Quick Start with Docker
+## Running it
 
-The easiest way to get TigerBug running is with Docker Compose:
+Easiest way is with Docker:
 
-#### docker-compose.yml
 ```yaml
 services:
   tigerbug:
@@ -61,22 +48,39 @@ services:
     volumes:
       - ./data:/app/server/data
     environment:
-      - JWT_SECRET=your-super-secret-jwt-key-change-this-in-production
+      - JWT_SECRET=change-this-to-something-random
       - JWT_EXPIRES_IN=7d
     restart: unless-stopped
 ```
 
-### Why is there no Issues tab?
+Then go to http://localhost:9840 and create your admin account.
 
-This project has been made to meet our specific needs.
-We don't have the time and resources to maintain this project as a full-fledged issue tracker.  
-Feel free to fork and modify it for your own use cases.  
-For critical issues, please contact us directly at [contact@twobit-games.com](mailto:contact@twobit-games.com).
+## Issues and support
 
-### 📄 License
+We built this for our own use and open-sourced it in case it's useful to others. We don't have time to maintain it as a full project, so there's no Issues tab here.
 
-TigerBug is open source software licensed under the MIT License. See [LICENSE](LICENSE) for details.
+If you find a critical bug, email us at [contact@twobit-games.com](mailto:contact@twobit-games.com). Otherwise, feel free to fork it and make it work for your needs.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
 
 ---
 
-**Built with ❤️ by TwoBit Games**
+Built with ❤️ by TwoBit Games
+
+[contributors-shield]: https://img.shields.io/github/contributors/TwoBitGames/TigerBug.svg?style=for-the-badge
+
+[contributors-url]: https://github.com/TwoBitGames/TigerBug/graphs/contributors
+
+[forks-shield]: https://img.shields.io/github/forks/TwoBitGames/TigerBug.svg?style=for-the-badge
+
+[forks-url]: https://github.com/TwoBitGames/TigerBug/network/members
+
+[stars-shield]: https://img.shields.io/github/stars/TwoBitGames/TigerBug.svg?style=for-the-badge
+
+[stars-url]: https://github.com/TwoBitGames/TigerBug/stargazers
+
+[license-shield]: https://img.shields.io/github/license/TwoBitGames/TigerBug.svg?style=for-the-badge
+
+[license-url]: https://github.com/TwoBitGames/TigerBug/blob/master/LICENSE

docs/.vitepress/config.mjs

@@ -0,0 +1,52 @@
+import {defineConfig} from 'vitepress'
+
+export default defineConfig({
+    title: 'TigerBug',
+    description: 'Lightweight game-focused issue tracker',
+    cleanUrls: true,
+    head: [
+        ['link', {rel: 'icon', type: 'image/png', href: '/favicon.png'}]
+    ],
+    themeConfig: {
+        logo: '/favicon.png',
+        siteTitle: 'TigerBug',
+        search: {
+            provider: 'local'
+        },
+        nav: [
+            {text: 'Guide', link: '/guide/getting-started'},
+            {text: 'Configuration', link: '/configuration/environment-variables'}
+        ],
+        sidebar: {
+            '/guide/': [
+                {
+                    text: 'Guide',
+                    items: [
+                        {text: 'Getting Started', link: '/guide/getting-started'}
+                    ]
+                }
+            ],
+            '/configuration/': [
+                {
+                    text: 'Configuration',
+                    items: [
+                        {text: 'Environment Variables', link: '/configuration/environment-variables'},
+                        {text: 'SMTP & Email', link: '/configuration/email-smtp'},
+                        {text: 'OAuth', link: '/configuration/oauth'},
+                    ]
+                }
+            ]
+        },
+        editLink: {
+            pattern: 'https://github.com/TwoBitGames/TigerBug/edit/main/docs/:path',
+            text: 'Edit this page on GitHub'
+        },
+        socialLinks: [
+            {icon: 'github', link: 'https://github.com/TwoBitGames/TigerBug'}
+        ],
+        footer: {
+            message: 'MIT License',
+            copyright: '© 2025 TwoBit Games'
+        }
+    }
+})

docs/.vitepress/theme/custom.css

@@ -0,0 +1,100 @@
+:root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: hsl(31, 71%, 52%);
+  --vp-c-brand-2: hsl(31, 71%, 60%);
+  --vp-c-brand-3: hsl(31, 71%, 48%);
+  --vp-c-brand-soft: hsla(31, 71%, 52%, 0.14);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+.dark {
+  --vp-c-brand-1: hsl(31, 71%, 65%);
+  --vp-c-brand-2: hsl(31, 71%, 70%);
+  --vp-c-brand-3: hsl(31, 71%, 60%);
+  --vp-c-brand-soft: hsla(31, 71%, 65%, 0.16);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    var(--vp-c-brand-1) 30%,
+    var(--vp-c-brand-2)
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    var(--vp-c-brand-1) 50%,
+    var(--vp-c-brand-2) 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}

docs/.vitepress/theme/index.js

@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default DefaultTheme

docs/configuration/email-smtp.md

@@ -0,0 +1,32 @@
+# Email Setup
+
+TigerBug sends emails for account verification, notifications, and other important stuff. Here's how to get it working.
+
+## What needs email
+- New account verification 
+- Welcome messages
+- Issue and comment notifications
+- Assignment alerts
+- Test emails (to make sure everything works)
+
+## Setting it up
+Go to Admin Dashboard → SMTP Configuration and fill in:
+- **Host**: Your email server (like smtp.gmail.com)
+- **Port**: Usually 465 for secure connections
+- **Username & Password**: Your email credentials
+- **From Address**: What shows up as the sender
+- **Use TLS**: Check this unless you have certificate issues
+
+Hit save and TigerBug will test the connection. Check the logs to see if it worked.
+
+## Testing
+Use the test email form in the admin panel to make sure everything's working before your users need it.
+
+## When things go wrong
+| Problem | Usually means | Try this |
+|---------|-------|-----|
+| Connection timeout | Firewall or wrong server | Test with `nc -vz yourhost 465` |
+| Certificate errors | Self-signed or bad SSL | Uncheck "Use TLS" or fix your certificates |
+| Authentication failed | Wrong username/password | Double-check your credentials |
+
+Most email providers have specific setup guides - Gmail, Outlook, etc. all work fine.

docs/configuration/environment-variables.md

@@ -0,0 +1,21 @@
+# Environment Variables
+
+Here's what you can configure when running TigerBug. Most of these have sensible defaults, but you'll want to set a few
+for production.
+
+| Variable       | Required | Default                                                      | What it does                                                            |
+|----------------|----------|--------------------------------------------------------------|-------------------------------------------------------------------------|
+| PORT           | No       | 9840                                                         | Which port the server runs on                                           |
+| CLIENT_URL     | No       | http://localhost:5173 (dev) / http://localhost:9840 (Docker) | The URL people will use to access TigerBug (needed for emails and CORS) |
+| JWT_SECRET     | Yes      | (none)                                                       | A secret key for login tokens - make this random and keep it safe!      |
+| JWT_EXPIRES_IN | No       | 7d                                                           | How long people stay logged in (1d = 1 day, 7d = 1 week, etc.)          |
+| UPLOAD_PATH    | No       | /app/server/data/attachments                                 | Where uploaded files get stored                                         |
+| NODE_ENV       | No       | development                                                  | Set to "production" to hide debug info from users                       |
+
+## Email Setup
+
+Email gets configured through the admin UI, not environment variables. Much easier that way.
+
+## How it works
+
+The server uses your `CLIENT_URL` setting to handle CORS and serve the web interface from the built files.

docs/configuration/oauth.md

@@ -0,0 +1,19 @@
+# OAuth Login Providers
+
+Let people log in with Google, GitHub, Discord, or other services instead of creating yet another password.
+
+## Setting it up
+
+1. Go to Admin Dashboard → OAuth
+2. For each provider you want (Google, GitHub, etc.):
+    - **Client ID & Secret**: Get these from the provider's developer console
+    - **Scope**: What permissions to ask for (provider-specific)
+    - **Callback URL**: Copy this and paste it into the provider's settings
+    - **Enable/Disable**: Turn providers on and off
+3. Hit Save
+
+## How it works
+
+The login page pulls the list of enabled providers and shows nice branded buttons for each one.
+
+Each provider stores its config in the database, so you can manage everything through the admin UI.