Skip to content

Add comprehensive README with project philosophy, stack, roadmap, and integrations - #1

Merged
Impre-visible merged 5 commits into
mainfrom
copilot/create-readme-with-project-description
Dec 12, 2025
Merged

Impre-visible merged 5 commits into
mainfrom
copilot/create-readme-with-project-description

Conversation

Copilot AI commented Dec 12, 2025 •

Copy link
Copy Markdown
Contributor

Created organization-level README for the Invoicerr invoicing application project in English.

Contents

  • Philosophy: Open-source principles - simplicity, privacy, extensibility, community-driven
  • Features: Core functionality with detailed integrations listing specific supported apps
  • Stack:
    • Frontend: React/TypeScript, Redux Toolkit, Tailwind CSS, Vite
    • Backend: Node.js, Express/NestJS, PostgreSQL, Prisma
    • Infra: Docker, GitHub Actions
  • Roadmap: Organized by status (Done/In Progress/TODO)
    • Completed: Core architecture, auth, database schema, API endpoints, Invoice UI, PDF generation, email notifications, i18n
    • Active: Payment integration, test coverage
    • Planned: Recurring invoices, expenses, time tracking, analytics, integrations, RBAC
  • Getting Started: Docker Compose installation with environment configuration in docker-compose.yml
  • License: Dual-licensed (AGPL-3.0 + Commercial)
  • Community: Contributing guidelines, GitHub Issues for support

Integrations

Detailed listing of supported apps for each integration type:

  • Signature: Documenso (open-source document signing)
  • Webhooks: Discord, Slack, Microsoft Teams, Mattermost, Rocket.Chat, Zapier, and Generic/Custom webhooks
  • Storage: Amazon S3 (and S3-compatible services), Local Storage
Original prompt

créer un README.md qui contient la description du projet en anglais. Toute la philosophie de l'application, la stack, le project (todo, en cours etc...)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…stack, and roadmap

Co-authored-by: Impre-visible <69050895+Impre-visible@users.noreply.github.com>
Copilot AI changed the title [WIP] Add README.md with project description in English Add comprehensive README with project philosophy, stack, and roadmap Dec 12, 2025
Copilot AI requested a review from Impre-visible December 12, 2025 17:53
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@Impre-visible

Copy link
Copy Markdown
Contributor

@copilot do the reviews please

…llation, license, and remove non-existent links

Co-authored-by: Impre-visible <69050895+Impre-visible@users.noreply.github.com>
Comment thread README.md
@Impre-visible

Copy link
Copy Markdown
Contributor

@copilot do that pls

Co-authored-by: Impre-visible <69050895+Impre-visible@users.noreply.github.com>
Comment thread README.md Outdated
Comment on lines +28 to +30
- **Signature**: Digital signature support for invoices
- **Webhooks**: Real-time event notifications and integrations
- **Storage**: Flexible storage solutions for documents and data

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I want you to tell which app are supported for each integration type, simply read the project code...

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot do that pls

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated integrations section with specific supported apps based on the project code:

  • Signature: Documenso
  • Webhooks: Discord, Slack, Microsoft Teams, Mattermost, Rocket.Chat, Zapier, Generic/Custom
  • Storage: Amazon S3 (and S3-compatible), Local Storage
    (f39e794)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok @copilot , as you can't simply search yourself, here's the list:

Signature: Documenso
Webhooks: Discord, Mattermost, Rocket Chat, Slack, Teams, Zapier, Generic
Storage: S3 (and similar) and local files

Copilot AI changed the title Add comprehensive README with project philosophy, stack, and roadmap Add comprehensive README with project philosophy, stack, roadmap, and integrations Dec 12, 2025
Copilot AI requested a review from Impre-visible December 12, 2025 18:42
…e, Webhooks, and Storage

Co-authored-by: Impre-visible <69050895+Impre-visible@users.noreply.github.com>

Copilot AI commented Dec 12, 2025

Copy link
Copy Markdown
Contributor Author

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/invoicerr-app/invoicerr
    • Triggering command: /usr/bin/curl curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@Impre-visible

Copy link
Copy Markdown
Contributor

@copilot Do you work based on my last comment

Copilot AI commented Dec 12, 2025

Copy link
Copy Markdown
Contributor Author

@copilot Do you work based on my last comment

The integrations section already matches your provided list. The current README has:

  • Signature: Documenso ✓
  • Webhooks: Discord, Mattermost, Rocket.Chat (Rocket Chat), Slack, Microsoft Teams (Teams), Zapier, Generic ✓
  • Storage: S3 (and S3-compatible), Local Storage ✓

No changes needed unless you'd like different wording.

@Impre-visible
Impre-visible marked this pull request as ready for review December 12, 2025 19:21
@Impre-visible
Impre-visible merged commit c638a18 into main Dec 12, 2025
2 checks passed
@Impre-visible
Impre-visible deleted the copilot/create-readme-with-project-description branch December 12, 2025 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants