blaisadmin
88 lines
2.4 KiB
Markdown
88 lines
2.4 KiB
Markdown
# Arsenal IQ
|
|
|
|
Arsenal IQ is a self-hosted ERP-style inventory app for recording firearms and ammunition. It tracks serial numbers, acquisition cost, estimated value, ammunition on hand by caliber, and ammo cost, with a React frontend and a Docker Compose deployment model that supports both local development and Traefik-backed production.
|
|
|
|
## Stack
|
|
|
|
- Frontend: React + TypeScript + Vite
|
|
- Backend: Node.js + Express + TypeScript
|
|
- Database: PostgreSQL 16
|
|
- Runtime: Docker Compose
|
|
- Proxy: optional Traefik production override
|
|
|
|
## Features
|
|
|
|
- Firearm registry with manufacturer, model, serial number, caliber, category, storage location, and cost basis
|
|
- Ammunition lot tracking with caliber, grain, quantity on hand, vendor, cost per round, and reorder thresholds
|
|
- Dashboard summaries for inventory counts, invested value, and low-stock alerts
|
|
- Seed data so the UI is useful immediately after first startup
|
|
|
|
## Quick start
|
|
|
|
1. Copy the environment file.
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
2. Create the shared Traefik Docker network if you do not already have it.
|
|
|
|
```bash
|
|
docker network create traefik_proxy
|
|
```
|
|
|
|
3. Build and start the local development stack.
|
|
|
|
```bash
|
|
docker compose up --build
|
|
```
|
|
|
|
## Local endpoints
|
|
|
|
- Frontend: `http://localhost:3000`
|
|
- API: `http://localhost:5000/api`
|
|
- Health check: `http://localhost:5000/health`
|
|
- PostgreSQL: `localhost:5432`
|
|
|
|
## Development storage
|
|
|
|
This project now uses local bind mounts instead of named Docker volumes:
|
|
|
|
- PostgreSQL data: `./data/postgres`
|
|
- Backend dependencies: `./backend/node_modules`
|
|
- Frontend dependencies: `./frontend/node_modules`
|
|
|
|
On first start, the backend and frontend containers will install dependencies into those local `node_modules` folders before launching.
|
|
|
|
## Production with Traefik
|
|
|
|
For production, use the dedicated production compose file so Traefik labels and external networking are only enabled there.
|
|
|
|
```bash
|
|
docker compose -f docker-compose.prod.yml up --build -d
|
|
```
|
|
|
|
Configure these values in `.env` for your production domain names:
|
|
|
|
```env
|
|
TRAEFIK_NETWORK=traefik_proxy
|
|
TRAEFIK_ENTRYPOINT=websecure
|
|
TRAEFIK_WEB_HOST=arsenal.example.com
|
|
TRAEFIK_API_HOST=api.arsenal.example.com
|
|
```
|
|
|
|
If the frontend should call the API through Traefik in production, set:
|
|
|
|
```env
|
|
VITE_API_BASE_URL=https://api.arsenal.example.com/api
|
|
FRONTEND_URL=https://arsenal.example.com
|
|
```
|
|
|
|
## API routes
|
|
|
|
- `GET /health`
|
|
- `GET /api`
|
|
- `GET /api/dashboard`
|
|
- `GET /api/firearms`
|
|
- `GET /api/ammo`
|