Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Bug Report
about: Create a report to help us improve InboxOS
title: '[BUG] '
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Feature Request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: enhancement
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.
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

## Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
File renamed without changes.
40 changes: 40 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 InboxOS Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,27 +351,21 @@ This monorepo isolates individual layers and clients under clean folders. All sy

```text
InboxOS/
├── assets/ # Logos, screenshots, and branding assets
├── backend/ # Node.js backend server (Express + Prisma)
├── .github/ # Community files, PR templates, GitHub Actions
├── frontend/ # React frontend client (Vite)
├── backend/ # Node.js backend server (Express + Prisma)
├── packages/ # Decoupled libraries and shared modules
├── scripts/ # Build, setup, and deployment scripts
├── docs/ # Developer manuals & architecture logs
│ ├── api/ # API specifications and Postman config
│ ├── architecture/ # Architecture design records and schema docs
│ ├── contributing/ # Contribution guidelines
│ ├── setup/ # Setup instructions
│ └── workflows/ # Workflow definitions
├── development/ # Developer-only workspace
│ ├── prompts/ # AI prompt definitions
│ ├── scratch/ # Local scratch scripts and dumps
│ └── scripts/ # Development utility scripts
├── infrastructure/ # Configurations for running the application
│ ├── docker/ # Docker Compose configurations
│ ├── terraform/ # Terraform scripts for cloud provisioning
│ ├── postgres/ # PostgreSQL initialization scripts
│ ├── config/ # Env and gitignore template configurations
│ └── github/ # GitHub actions configurations
├── .gitignore # Git tracking rules
├── .firebaserc # Firebase CLI target configs (required for deployment)
├── firebase.json # Firebase rules and routing (required for deployment)
├── docker-compose.yml # Local full-stack orchestration
├── package.json # Root package workspace definition
└── README.md # Repository Hero and Reference manual (this file)
```
Expand All @@ -398,14 +392,14 @@ git clone https://github.com/inboxos/inboxos.git
cd inboxos

# 2. Copy and configure variables
cp infrastructure/config/env/.env.example infrastructure/config/env/.env
# Edit infrastructure/config/env/.env with your secrets
cp scripts/config/env/.env.example scripts/config/env/.env
# Edit scripts/config/env/.env with your secrets

# 3. Spin up all services (PostgreSQL, Redis, Backend, Frontend)
docker compose -f infrastructure/docker/docker-compose.yml up -d
docker compose up -d

# 4. Execute database migrations
docker compose -f infrastructure/docker/docker-compose.yml exec backend npx prisma db push
docker compose exec backend npx prisma db push

# 5. Open the Dashboard UI
# Access the dashboard at http://localhost
Expand All @@ -421,7 +415,7 @@ For active local debugging of individual services without Docker containerizatio
```bash
cd backend
npm install
# Configure backend/.env or use infrastructure/config/env/.env
# Configure backend/.env or use scripts/config/env/.env
npm start
```

Expand Down
13 changes: 13 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Security Policy

## Supported Versions

Currently, only the `main` branch (latest release) is supported with security updates.

## Reporting a Vulnerability

Please do not report security vulnerabilities through public GitHub issues.

Instead, please report them directly to the maintainers by emailing `security@inboxos.com` (or the respective maintainer email).

You should receive a response within 48 hours. If the issue is confirmed as a vulnerability, we will open a private Security Advisory on GitHub and work on a patch.
10 changes: 5 additions & 5 deletions infrastructure/docker/docker-compose.yml → docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ services:
- "5432:5432"
volumes:
- postgres_data:/var/lib/postgresql/data
- ../postgres/init.sql:/docker-entrypoint-initdb.d/init.sql
- ./scripts/postgres/init.sql:/docker-entrypoint-initdb.d/init.sql
healthcheck:
test: [ "CMD-SHELL", "pg_isready -U postgres -d inboxos" ]
interval: 5s
Expand Down Expand Up @@ -41,7 +41,7 @@ services:
# ==========================================
backend:
build:
context: ../../backend
context: ./backend
dockerfile: Dockerfile
target: dev
restart: unless-stopped
Expand All @@ -62,7 +62,7 @@ services:
- GEMINI_API_KEY=${GEMINI_API_KEY:-}
- AI_PROVIDER=${AI_PROVIDER:-openai}
volumes:
- ../../backend:/usr/src/app
- ./backend:/usr/src/app
# Anonymous volume to preserve node_modules installed inside the container
- /usr/src/app/node_modules
depends_on:
Expand All @@ -78,7 +78,7 @@ services:
# ==========================================
frontend:
build:
context: ../../frontend
context: ./frontend
dockerfile: Dockerfile
target: dev
restart: unless-stopped
Expand All @@ -87,7 +87,7 @@ services:
environment:
- VITE_API_BASE_URL=http://localhost:8000
volumes:
- ../../frontend:/app
- ./frontend:/app
# Anonymous volume to preserve node_modules installed inside the container
- /app/node_modules
depends_on:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading