docs: README ve CHANGELOG (0.1.0)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-11-05 01:08:10 +03:00
parent c45e58c732
commit 708e4cf5c6
2 changed files with 72 additions and 26 deletions
+43 -26
View File
@@ -1,36 +1,53 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# BÜTÇEM
## Getting Started
Aile bütçesi, banka/kart/cari hesapları, birikimler (altın, döviz, ziynet), aylık bütçe, ev stoğu ve akıllı alışveriş listelerini tek yerde yöneten, çok kullanıcılı web uygulaması.
First, run the development server:
- Ürün tanımı, mimari kurallar ve faz planı: [docs/PROMPT.md](docs/PROMPT.md)
- Sürüm geçmişi: [CHANGELOG.md](CHANGELOG.md)
## Teknoloji
Next.js 16 (App Router, Turbopack, Cache Components) · React 19 · TypeScript (strict) · Tailwind CSS 4 · shadcn/ui (Radix) · Better Auth · MongoDB 9 (native driver + Mongoose) · zod · Vitest
## Gereksinimler
- Node.js **26** (Active LTS) — `nvm use` (`.nvmrc`)
- Docker + Docker Compose (lokal MongoDB replica set)
## Lokal geliştirme
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
# 1) Bağımlılıklar
npm install
# 2) Ortam değişkenleri — BETTER_AUTH_SECRET için: openssl rand -base64 32
cp .env.example .env.local
# 3) MongoDB (tek düğümlü replica set rs0, host portu 27019) — sağlıklı olana kadar bekler
npm run db:up
# 4) Uygulama
npm run dev # http://localhost:3000
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Scriptler
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
| Komut | Açıklama |
| ----------------------------- | -------------------------------- |
| `npm run dev` | Geliştirme sunucusu |
| `npm run build` / `start` | Üretim build'i / sunucusu |
| `npm run lint` | ESLint |
| `npm run typecheck` | `tsc --noEmit` |
| `npm run test` | Vitest birim testleri |
| `npm run format` | Prettier |
| `npm run db:up` / `db:down` | Lokal MongoDB'yi başlat / durdur |
| `npm run seed` / `seed:reset` | Örnek veri (Faz 4) |
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Docker imajı
## Learn More
```bash
docker build --build-arg APP_VERSION=$(node -p "require('./package.json').version") \
--build-arg APP_COMMIT=$(git rev-parse --short HEAD) -t butcem .
```
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
Canlı ortam (Dokploy, `butcem.ta1sph.website`) kurulumu Faz 15'te `docs/DEPLOY.md` içinde anlatılacak.