feat: initial project setup
- Add .NET 8 backend with Clean Architecture - Add React + Vite + TypeScript frontend - Implement authentication with JWT - Implement Azure Blob Storage client - Implement OCR integration - Implement supplier matching service - Implement voucher generation - Implement Fortnox provider - Add unit and integration tests - Add Docker Compose configuration
This commit is contained in:
78
README.md
Normal file
78
README.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# Invoice Master
|
||||
|
||||
Multi-accounting system invoice processing platform supporting Fortnox, Visma, Hogia, and more.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Backend**: .NET 8 + ASP.NET Core + EF Core + PostgreSQL
|
||||
- **Frontend**: React 18 + TypeScript + Vite + TailwindCSS
|
||||
- **Infrastructure**: Docker + Azure
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- .NET 8 SDK
|
||||
- Node.js 18+
|
||||
- Docker & Docker Compose
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone <repo-url>
|
||||
cd invoice-master
|
||||
|
||||
# Start infrastructure services
|
||||
docker-compose up -d postgres redis
|
||||
|
||||
# Run backend
|
||||
cd backend
|
||||
dotnet restore
|
||||
dotnet run --project src/InvoiceMaster.API
|
||||
|
||||
# Run frontend (in another terminal)
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Docker Compose (Full Stack)
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Services:
|
||||
- Backend API: http://localhost:5000
|
||||
- Frontend: http://localhost:5173
|
||||
- Swagger UI: http://localhost:5000/swagger
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
├── backend/ # .NET Backend
|
||||
│ ├── src/
|
||||
│ │ ├── InvoiceMaster.API/ # Web API
|
||||
│ │ ├── InvoiceMaster.Core/ # Domain layer
|
||||
│ │ ├── InvoiceMaster.Application/ # Application layer
|
||||
│ │ ├── InvoiceMaster.Infrastructure/# Infrastructure layer
|
||||
│ │ └── InvoiceMaster.Integrations/ # Accounting providers
|
||||
│ └── tests/
|
||||
├── frontend/ # React Frontend
|
||||
│ └── src/
|
||||
├── docs/ # Documentation
|
||||
└── docker-compose.yml # Local development
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Architecture](ARCHITECTURE.md)
|
||||
- [API Design](API_DESIGN.md)
|
||||
- [Database Schema](DATABASE_SCHEMA.md)
|
||||
- [Development Plan](DEVELOPMENT_PLAN.md)
|
||||
- [Deployment Guide](DEPLOYMENT_GUIDE.md)
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user