|
| 1 | +# Nexpenz API 💰📊 |
| 2 | + |
| 3 | +**Nexpenz API** is a simple, fast, and secure backend API for a personal finance |
| 4 | +tracking mobile application. |
| 5 | +It powers the Nexpenz Android app, enabling users to track income, expenses, |
| 6 | +and view financial summaries — without signup or ads. |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## 🚀 Features |
| 11 | + |
| 12 | +- ✅ Add income & expenses instantly |
| 13 | +- 📈 Monthly summaries & category-based analytics |
| 14 | +- 🧾 Full transaction history |
| 15 | +- 🌍 Multi-currency support |
| 16 | +- 🔐 API key authentication (no login/signup) |
| 17 | +- 🧡 100% free — no ads, no tracking |
| 18 | +- 🐳 Docker-ready |
| 19 | +- 🧪 CI-tested on Linux |
| 20 | + |
| 21 | +--- |
| 22 | + |
| 23 | +## 🛠️ Tech Stack |
| 24 | + |
| 25 | +- **Python 3.11** |
| 26 | +- **Django** |
| 27 | +- **Django REST Framework** |
| 28 | +- **djangorestframework-api-key** |
| 29 | +- **SQLite / PostgreSQL** |
| 30 | +- **Docker & Docker Compose** |
| 31 | +- **GitHub Actions (CI)** |
| 32 | + |
| 33 | +--- |
| 34 | + |
| 35 | +## 🐧 OS Support |
| 36 | + |
| 37 | +| OS | Status | |
| 38 | +|--------|--------| |
| 39 | +| Linux | ✅ Fully supported & recommended | |
| 40 | +| macOS | ✅ Supported | |
| 41 | +| Windows| ⚠️ Supported (WSL recommended) | |
| 42 | + |
| 43 | +> **Tested on Linux (Ubuntu). Linux is recommended for production.** |
| 44 | +
|
| 45 | +--- |
| 46 | + |
| 47 | +### API Authentication |
| 48 | + |
| 49 | +This API uses API Key authentication. |
| 50 | +- Create API Key |
| 51 | +- Log in to Django Admin |
| 52 | +- Navigate to API Keys |
| 53 | +- Create a key |
| 54 | +-Copy it once (shown only once) |
| 55 | + |
| 56 | +or goto nexpenz.nexapytechnologies.com/api/signup to generate a key |
| 57 | + |
| 58 | +## ⚙️ Local Setup (Linux / Windows) |
| 59 | + |
| 60 | +Follow these steps to run the project locally: |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | +api will be accessible at |
| 66 | +http://locahost:8000 |
| 67 | + |
| 68 | + |
| 69 | +## Example code |
| 70 | +GET /api/transactions/ |
| 71 | +X-API-KEY: your_api_key_here |
| 72 | + |
| 73 | + |
| 74 | +## 1. DOWNLOAD APK FILE |
| 75 | +http://locahost:8000/downoad_nexpenz |
| 76 | + |
| 77 | +### 1. Clone the repo |
| 78 | + |
| 79 | +```bash |
| 80 | +git clone https://github.com/nexapytech/Expense-Tracker-app |
| 81 | +cd Expense-Tracker-app |
| 82 | + |
| 83 | +### Docker Setup (Recommended) |
| 84 | +docker build -t nexpenz . |
| 85 | +docker run -p 8000:8000 nexpenz |
| 86 | + |
| 87 | + |
| 88 | + |
0 commit comments