Skip to content

Commit 3294e1a

Browse files
committed
chore: update readme and landing texts
1 parent d0b0c75 commit 3294e1a

File tree

2 files changed

+95
-96
lines changed

2 files changed

+95
-96
lines changed

README.md

Lines changed: 86 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -2,110 +2,112 @@
22

33
<img src="public/logo/512.png" alt="" width="320">
44

5-
# TaxHacker
5+
<br>
66

7-
I'm a small self-hosted accountant app that can help you deal with invoices, receipts and taxes with power of GenAI.<br/><br/>
7+
# TaxHacker — self-hosted AI accountant
88

99
[![GitHub Stars](https://img.shields.io/github/stars/vas3k/TaxHacker?color=ffcb47&labelColor=black&style=flat-square)](https://github.com/vas3k/TaxHacker/stargazers)
1010
[![License](https://img.shields.io/badge/license-MIT-ffcb47?labelColor=black&style=flat-square)](https://github.com/vas3k/TaxHacker/blob/main/LICENSE)
1111
[![GitHub Issues](https://img.shields.io/github/issues/vas3k/TaxHacker?color=ff80eb&labelColor=black&style=flat-square)](https://github.com/vas3k/TaxHacker/issues)
1212
[![Donate](https://img.shields.io/badge/-Donate-f04f88?logo=githubsponsors&logoColor=white&style=flat-square)](https://vas3k.com/donate/)
1313

14-
**Share TaxHacker**
15-
16-
[![Share on X](https://img.shields.io/badge/-share%20on%20x-black?labelColor=black&logo=x&logoColor=white&style=flat-square)](https://x.com/intent/tweet?text=Check%20out%20TaxHacker%20-%20an%20AI-powered%20assistant%20that%20helps%20you%20manage%20receipts%2C%20checks%2C%20and%20invoices%20with%20ease.&url=https%3A%2F%2Fgithub.com%2Fvas3k%2FTaxHacker)
17-
[![Share on LinkedIn](https://img.shields.io/badge/-share%20on%20linkedin-black?labelColor=black&logo=linkedin&logoColor=white&style=flat-square)](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fgithub.com%2Fvas3k%2FTaxHacker)
18-
[![Share on Reddit](https://img.shields.io/badge/-share%20on%20reddit-black?labelColor=black&logo=reddit&logoColor=white&style=flat-square)](https://www.reddit.com/submit?title=Check%20out%20TaxHacker%20-%20an%20AI-powered%20assistant%20that%20helps%20you%20manage%20receipts%2C%20checks%2C%20and%20invoices%20with%20ease.&url=https%3A%2F%2Fgithub.com%2Fvas3k%2FTaxHacker)
19-
2014
</div>
2115

22-
## 👋🏻 Getting Started
16+
TaxHacker is a self-hosted accounting app designed for freelancers, indie hackers, and small businesses who want to save time and automate expense and income tracking using the power of modern AI.
2317

24-
TaxHacker is a self-hosted accounting app for freelancers, indie-hackers and small businesses who want to save time and automate expences and income tracking with power of GenAI. It can recognise uploaded photos, receipts or PDFs and extract important data (e.g. name, total amount, date, merchant, VAT) and save it as structured transactions to a table. You can also create your own custom fields to extract with your LLM prompts.
18+
Upload photos of receipts, invoices, or PDFs, and TaxHacker will automatically recognize and extract all the important data you need for accounting: product names, amounts, items, dates, merchants, taxes, and save it into a structured Excel-like database. You can even create custom fields with your own AI prompts to extract any specific information you need.
2519

26-
It supports automatic currency conversion on a day of transaction. Even for crypto!
20+
The app features automatic currency conversion (including crypto!) based on historical exchange rates from the transaction date. With built-in filtering, multi-project support, import/export capabilities, and custom categories, TaxHacker simplifies reporting and makes tax filing a bit easier.
2721

28-
Built-in system of filters, support for multiple projects, import-export of transactions for a certain time (along with attached files) and custom categories, allows you to simplify reporting and tax filing.
22+
> 🎥 [Watch demo video](public/landing/video.mp4)
2923
3024
![Dashboard](public/landing/main-page.webp)
3125

3226
> \[!IMPORTANT]
3327
>
34-
> This project is still at a very early stage. Use it at your own risk! **Star Us** to receive notifications about new bugfixes and features from GitHub ⭐️
28+
> This project is still in early development. Use at your own risk! **Star us** to get notified about new features and bugfixes ⭐️
3529
3630
## ✨ Features
3731

38-
### `1` Upload photos or documents to analyze with LLM
32+
### `1` Analyze photos and invoices with AI
3933

4034
![Currency Conversion](public/landing/ai-scanner-big.webp)
4135

42-
https://github.com/user-attachments/assets/3326d0e3-0bf6-4c39-9e00-4bf0983d9b7a
43-
44-
> 🎥 [Watch the video](https://github.com/user-attachments/assets/3326d0e3-0bf6-4c39-9e00-4bf0983d9b7a)
45-
46-
Take a photo on upload or a PDF and TaxHacker will automatically recognise, categorise and store transaction information.
36+
Snap a photo of any receipt or upload an invoice PDF, and TaxHacker will automatically recognize, extract, categorize, and store all the information in a structured database.
4737

48-
- Upload multiple documents and store in "unsorted" until you get the time to sort them out by hand or with an AI
49-
- Use LLM to extract key information like date, amount, and vendor
50-
- Automatically categorize transactions based on its content
51-
- Store everything in a structured format for easy filtering and retrieval
52-
- Organize your documents by a tax season
38+
- **Upload and organize your docs**: Store multiple documents in "unsorted" until you're ready to process them manually or with AI assistance
39+
- **AI data extraction**: Use AI to automatically pull key information like dates, amounts, vendors, and line items
40+
- **Auto-categorization**: Transactions are automatically sorted into relevant categories based on their content
41+
- **Item splitting**: Extract individual items from invoices and split them into separate transactions when needed
42+
- **Structured storage**: Everything gets saved in an organized database for easy filtering and retrieval
43+
- **Customizable AI providers**: Choose from OpenAI, Google Gemini, or Mistral (local LLM support coming soon)
5344

54-
TaxHacker recognizes a wide variety of documents including store receipts, restaurant bills, invoices, bank checks, letters, even handwritten receipts.
45+
TaxHacker works with a wide variety of documents, including store receipts, restaurant bills, invoices, bank statements, letters, even handwritten receipts. It handles any language and any currency with ease.
5546

56-
### `2` Multi-currency support with automatic conversion (even for crypto)
47+
### `2` Multi-currency support with automatic conversion (even crypto!)
5748

5849
![Currency Conversion](public/landing/multi-currency.webp)
5950

60-
TaxHacker automatically converts foreign currencies and even knows the historical exchange rates on the invoice date.
51+
TaxHacker automatically detects currencies in your documents and converts them to your base currency using historical exchange rates.
6152

62-
- Automatically detect currency in your documents
63-
- Convert it to your base currency
64-
- Historical exchange rate lookup for past transactions
65-
- Support for over 170 world currencies and 14 popular cryptocurrencies (BTC, ETC, LTC, DOT, etc)!
53+
- **Foreight currency detection**: Automatically identify the currency used in any document
54+
- **Historical rates**: Get conversion rates from the actual transaction date
55+
- **All-world coverage**: Support for 170+ world currencies and 14 popular cryptocurrencies (BTC, ETH, LTC, DOT, and more)
56+
- **Flexible input**: Manual entry is always available when you need more control
6657

67-
### `3` Create custom fields, projects, categories
58+
### `3` Organize your transactions using fully customizable categories, projects and fields
6859

6960
![Transactions Table](public/landing/transactions-big.webp)
7061

71-
Adapt TaxHacker to your specific tracking needs. You can create new fields, projects or categories to extract additional information from documents. For example, if you need to save emails, addresses, and any custom information into separate fields, you can do it. Custom fields will be available when exporting too.
62+
Adapt TaxHacker to your unique needs with unlimited customization options. Create custom fields, projects, and categories that better suit your specific needs, idustry standards or country.
7263

73-
- Create unlimited custom fields for transaction tracking
74-
- Automatically extract custom field data using AI
75-
- Include custom fields in exports and reports
76-
- Create new categories or projects to organise your transactions and filter by them
64+
- **Custom categories and projecst**: Create your own categories and projects to group your transactions in any convenient way
65+
- **Custom fields**: You can create unlimited number of custom fields to extraxt more information from your invoices (it's like creating extra columns in Excel)
66+
- **Full-text search**: Search through the actual content of recognized documents
67+
- **Advanced filtering**: Find exactly what you need with search and filter options
68+
- **AI-powered extraction**: Write your own prompts to extract any custom information from documents
69+
- **Bulk operations**: Process multiple documents or transactions at once
7770

78-
### `4` `Customize any LLM prompt
71+
### `4` Customize any LLM prompt. Even system ones
7972

8073
![Custom Categories](public/landing/custom-llm.webp)
8174

82-
You can customize LLM Prompts for built-in fields, categories, and projects, as well as modify global templates in the application settings. This allows to customize the quality of recognizing specific things to your specific use-cases.
75+
Take full control of how TaxHacker's AI processes your documents. Write custom AI prompts for fields, categories, and projects, or modify the built-in ones to match your specific needs.
8376

84-
- General prompt template is configurable is settings
85-
- Create custom extraction rules for your specific needs
86-
- Adjust field extraction priorities and naming conventions
87-
- Fine-tune the AI for your industry-specific documents
77+
- **Customizable system prompts**: Modify the general prompt template in settings to suit your business
78+
- **Field or project-specific prompts**: Create custom extraction rules for your industry-specific documents
79+
- **Full control**: Adjust field extraction priorities and naming conventions to match your workflow
80+
- **Industry optimization**: Fine-tune the AI to understand your specific type of business documents
81+
- **Full transparency**: Every aspect of the AI extraction process is under your control and can be changed right in settings
8882

89-
The whole extraction process is under your contoll all the time!
83+
TaxHacker is 100% adaptable and tunable to your unique requirements — whether you need to extract emails, addresses, project codes, or any other custom information from your documents.
9084

9185
### `5` Flexible data filtering and export
9286

9387
![Data Export](public/landing/export.webp)
9488

95-
Once all documents have been uploaded and analyzed, you can view, filter and export your transaction history.
89+
Once your documents are processed, easily view, filter, and export your complete transaction history exactly how you need it.
9690

97-
- Filter transactions by time, category, and other features
98-
- Use full-text search by recognized document content
99-
- Export filtered transactions to CSV with attached documents
100-
- Upload your entire income and expense history at the end of the year for your tax advisor to analyze
91+
- **Advanced filtering**: Filter by date ranges, categories, projects, amounts, and any custom fields
92+
- **Flexible exports**: Export filtered transactions to CSV with all attached documents included
93+
- **Tax-ready reports**: Generate comprehensive reports for your accountant or tax advisor
94+
- **Data portability**: Download complete data archives to migrate to other services—your data stays yours
10195

102-
### `6` Local data storage and self-hosting
96+
### `6` Self-hosted mode for data privacy
10397

10498
![Self-hosting](docs/screenshots/exported_archive.png)
10599

106-
## 🛳 Deploying or Self-hosting
100+
Keep complete control over your financial data with local storage and self-hosting options. TaxHacker respects your privacy and gives you full ownership of your information.
107101

108-
TaxHacker can be self-hosted on your own infrastructure for complete control over your data and application environment. We provide a [Docker image](./Dockerfile) and [Docker Compose](./docker-compose.yml) files that makes setting up TaxHacker simple:
102+
- **Home server ready**: Host on your own infrastructure for maximum privacy and control
103+
- **Docker native**: Simple setup with provided Docker containers and compose files
104+
- **Data ownership**: Your financial documents never leaves your control
105+
- **No vendor lock-in**: Export everything and migrate whenever you want
106+
- **Transparent operations**: Full access to source code and complete operational transparency
107+
108+
## 🛳 Deployment and Self-hosting
109+
110+
TaxHacker can be easily self-hosted on your own infrastructure for complete control over your data and application environment. We provide a [Docker image](./Dockerfile) and [Docker Compose](./docker-compose.yml) setup that makes deployment simple:
109111

110112
```bash
111113
curl -O https://raw.githubusercontent.com/vas3k/TaxHacker/main/docker-compose.yml
@@ -116,15 +118,16 @@ docker compose up
116118
The Docker Compose setup includes:
117119

118120
- TaxHacker application container
119-
- PostgreSQL 17 database container
120-
- Automatic database migrations
121+
- PostgreSQL 17 database (or connect to your existing database)
122+
- Automatic database migrations on startup
121123
- Volume mounts for persistent data storage
124+
- Production-ready configuration
122125

123-
New docker image is automatically built and published on every new release. You can use specific version tags (e.g. `v1.0.0`) or `latest` for the most recent version.
126+
New Docker images are automatically built and published with every release. You can use specific version tags (e.g., `v1.0.0`) or `latest` for the most recent version.
124127

125-
For more advanced setups, you can adapt Docker Compose configuration to your own needs. The default configuration uses the pre-built image from GHCR, but you can still build locally using the provided [Dockerfile](./Dockerfile) if needed.
128+
For advanced setups, you can customize the Docker Compose configuration to fit your infrastructure. The default configuration uses the pre-built image from GitHub Container Registry, but you can also build locally using the provided [Dockerfile](./Dockerfile).
126129

127-
For example:
130+
Example custom configuration:
128131

129132
```yaml
130133
services:
@@ -143,35 +146,34 @@ services:
143146
144147
### Environment Variables
145148
146-
Configure TaxHacker to suit your needs with these environment variables:
149+
Configure TaxHacker for your specific needs with these environment variables:
147150
148151
| Variable | Required | Description | Example |
149152
|----------|----------|-------------|---------|
150-
| `UPLOAD_PATH` | Yes | Local directory for uploading files | `./data/uploads` |
153+
| `UPLOAD_PATH` | Yes | Local directory for file uploads and storage | `./data/uploads` |
151154
| `DATABASE_URL` | Yes | PostgreSQL connection string | `postgresql://user@localhost:5432/taxhacker` |
152-
| `PORT` | No | Port to run the app on | `7331` (default) |
155+
| `PORT` | No | Port to run the application on | `7331` (default) |
153156
| `BASE_URL` | No | Base URL for the application | `http://localhost:7331` |
154-
| `SELF_HOSTED_MODE` | No | Set it to "true" if you're self-hosting the app: it enables auto-login, custom API keys, and more | `true` |
157+
| `SELF_HOSTED_MODE` | No | Set to "true" for self-hosting: enables auto-login, custom API keys, and additional features | `true` |
155158
| `DISABLE_SIGNUP` | No | Disable new user registration on your instance | `false` |
156-
| `BETTER_AUTH_SECRET` | Yes | Secret key for authentication (min 16 characters) | `random-secret-key` |
157-
158-
You can also specify LLM provider options in settings or with environment variables:
159+
| `BETTER_AUTH_SECRET` | Yes | Secret key for authentication (minimum 16 characters) | `your-secure-random-key` |
159160

160-
- For OpenAI: `OPENAI_MODEL_NAME` and `OPENAI_API_KEY`
161-
- For Google: `GOOGLE_MODEL_NAME` and `GOOGLE_API_KEY`
162-
- For Mistral: `MISTRAL_MODEL_NAME` and `MISTRAL_API_KEY`
161+
You can also configure LLM provider settings in the application or via environment variables:
163162

163+
- **OpenAI**: `OPENAI_MODEL_NAME` and `OPENAI_API_KEY`
164+
- **Google Gemini**: `GOOGLE_MODEL_NAME` and `GOOGLE_API_KEY`
165+
- **Mistral**: `MISTRAL_MODEL_NAME` and `MISTRAL_API_KEY`
164166

165167
## ⌨️ Local Development
166168

167169
We use:
168170

169-
- Next.js version 15+ or later
170-
- [Prisma](https://www.prisma.io/) for database models and migrations
171-
- PostgreSQL as a database (PostgreSQL 17+ recommended)
172-
- Ghostscript and graphicsmagick libs for PDF files (can be installed on macOS via `brew install gs graphicsmagick`)
171+
- **Next.js 15+** for the frontend and API
172+
- **Prisma** for database models and migrations
173+
- **PostgreSQL** as the database (PostgreSQL 17+ recommended)
174+
- **Ghostscript and GraphicsMagick** for PDF processing (install on macOS via `brew install gs graphicsmagick`)
173175

174-
Set up a local development environment with these steps:
176+
Set up your local development environment:
175177

176178
```bash
177179
# Clone the repository
@@ -195,7 +197,7 @@ npx prisma generate && npx prisma migrate dev
195197
npm run dev
196198
```
197199

198-
Visit `http://localhost:7331` to see your local instance of TaxHacker.
200+
Visit `http://localhost:7331` to see your local TaxHacker instance in action.
199201

200202
For a production build, instead of `npm run dev` use the following commands:
201203

@@ -209,23 +211,24 @@ npm run start
209211

210212
## 🤝 Contributing
211213

212-
Contributions to TaxHacker are welcome and appreciated! Here's how you can help:
214+
We welcome contributions to TaxHacker! Here's how you can help make it even better:
213215

214-
- **Bug Reports**: File detailed issues when you encounter problems
215-
- **Feature Requests**: Share your ideas for new features
216-
- **Code Contributions**: Submit pull requests to improve the application
217-
- **Documentation**: Help improve documentation
216+
- **🐛 Bug Reports**: File detailed issues when you encounter problems
217+
- **💡 Feature Requests**: Share your ideas for new features and improvements
218+
- **🔧 Code Contributions**: Submit pull requests to improve the application
219+
- **📚 Documentation**: Help improve documentation and guides
220+
- **🎥 Content Creation**: Videos, tutorials, and reviews help us reach more users!
218221

219-
All work is done on GitHub through issues and pull requests.
222+
All development happens on GitHub through issues and pull requests. We appreciate any help.
220223

221224
[![PRs Welcome](https://img.shields.io/badge/🤯_PRs-welcome-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/vas3k/TaxHacker/pulls)
222225

223-
## ❤️ Donate
226+
## ❤️ Support the Project
224227

225-
If TaxHacker has helped you - help us in return! You donations will support maintainance and development. If you find this project valuable for your personal or business use, consider making a donation.
228+
If TaxHacker has helped you save time or manage your finances better, consider supporting its continued development! Your donations help us maintain the project, add new features, and keep it free and open source. Every contribution helps ensure we can keep improving and maintaining this tool for the community.
226229

227-
[![Donate to TaxHacker developers](https://img.shields.io/badge/❤️-donate%20to%20Taxhacker%20devs-f08080?labelColor=black&style=for-the-badge)](https://vas3k.com/donate/)
230+
[![Thank the TaxHacker devs](https://img.shields.io/badge/❤️-donate%20to%20Taxhacker%20devs-f08080?labelColor=black&style=for-the-badge)](https://vas3k.com/donate/)
228231

229232
## 📄 License
230233

231-
TaxHacker is licensed under the MIT License - see the [LICENSE](https://github.com/vas3k/TaxHacker/blob/main/LICENSE) file for details.
234+
TaxHacker is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)