first commit
This commit is contained in:
@@ -1,19 +1,55 @@
|
||||
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).
|
||||
# Otto — Travel Activity Planner
|
||||
|
||||
## Getting Started
|
||||
API-powered planner for things to do in your destination.
|
||||
Choose dates + **number of days**, pick an **Experience Mode** (Foodie, Cultural, Adventurous...), set a budget, and get a realistic day-by-day itinerary backed by live data from Geoapify and Ticketmaster.
|
||||
|
||||
First, run the development server:
|
||||
Everything in English. Follows `karpathy.md`.
|
||||
|
||||
## Quick Start (Docker recommended)
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
cp .env.example .env
|
||||
# Fill GEOAPIFY_API_KEY and TICKETMASTER_API_KEY (free tiers available)
|
||||
|
||||
docker compose -f docker-compose.dev.yml up --build
|
||||
```
|
||||
|
||||
Open http://localhost:3000
|
||||
|
||||
## Without Docker
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run db:migrate # requires a running Postgres (see .env)
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Key Features (MVP)
|
||||
- Explicit number of days (not just date math)
|
||||
- 6 Experience Modes that bias the entire plan
|
||||
- One-click adjustment buttons after generation
|
||||
- Budget respected + cost estimates
|
||||
- Real places + events from APIs
|
||||
- Leaflet map
|
||||
- Save & share by ID
|
||||
|
||||
See the detailed plan in the session `plan.md` for architecture and phases.
|
||||
|
||||
## Environment
|
||||
|
||||
Required keys (free tiers):
|
||||
- Geoapify
|
||||
- Ticketmaster
|
||||
|
||||
LLM key for future full generation (currently stubbed).
|
||||
|
||||
## Development
|
||||
|
||||
- Follow `karpathy.md` + `AGENTS.md`
|
||||
- `npm run lint`
|
||||
- `npm run build`
|
||||
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
Reference in New Issue
Block a user