PackRat

KO | EN

gitlite — search

#python #react #llm #android #machine-learning #rust #deep-learning #docker #nodejs #macos #windows #vue #security #ios

(★ 36)

PackRat is a versatile adventure planner tailored for outdoor enthusiasts. It simplifies the process of organizing trips from a simple day hike to cross-country journeys.

PackRat 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PackRat 🎒

PackRat is the ultimate adventure planner designed for those who love to explore the great outdoors. Our app helps users plan and organize their trips with ease, whether it's a weekend camping trip, a day hike, or a cross-country road trip.

With PackRat, you can create and manage trips, discover new destinations, and stay informed with up-to-date weather forecasts. Our app integrates with Mapbox to provide you with accurate maps and directions to your destinations, as well as suggestions for popular outdoor activities based on the location and season of your trip.

So pack your bags, grab your friends, and get ready for your next adventure with PackRat!

> [!NOTE]
> This project is currently in alpha. Please report any issues or bugs you encounter. Thank you for your patience and support!

> [!IMPORTANT]
> This project is still in development and may contain bugs or issues. Please use the app with caution and report any problems you encounter. Thank you for your understanding and cooperation.

**Build & CI:**
![Checks](https://github.com/PackRat-AI/PackRat/actions/workflows/checks.yml/badge.svg)
![API Tests](https://github.com/PackRat-AI/PackRat/actions/workflows/api-tests.yml/badge.svg)
![Database Migrations](https://github.com/PackRat-AI/PackRat/actions/workflows/migrations.yml/badge.svg)

**Repository Info:**
![GitHub tag](https://img.shields.io/github/tag/PackRat-AI/PackRat?include_prereleases=&sort=semver&color=blue)
![License](https://img.shields.io/badge/License-GNU-blue)
![issues - PackRat](https://img.shields.io/github/issues/PackRat-AI/PackRat)

[![View Beta Site](https://img.shields.io/badge/View%20Beta%20Site-%20-brightgreen)](https://packrat.world)

</div>

## Table of Contents

- [PackRat 🎒](#packrat-)
  - [Table of Contents](#table-of-contents)
  - [Overview 🌐](#overview-)
  - [Documentation 📚](#documentation-)
  - [Features 🚀](#features-)
  - [Technologies used 💻](#technologies-used-)
  - [🗂 Folder layout](#-folder-layout)
  - [🆕 Add new dependencies](#-add-new-dependencies)
    - [Pure JS dependencies](#pure-js-dependencies)
    - [Native dependencies](#native-dependencies)
    - [Mobile app dependencies](#mobile-app-dependencies)
    - [API dependencies](#api-dependencies)
    - [Web app dependencies](#web-app-dependencies)
  - [Dependency management](#dependency-management)
  - [Local installation 📲](#local-installation-)
    - [Dependencies](#dependencies)
    - [GitHub Packages Authentication](#github-packages-authentication)
    - [Environment Setup](#environment-setup)
    - [Git Hooks Setup](#git-hooks-setup)
    - [Installation & Development](#installation--development)
    - [Debugging 🐛](#debugging-)
  - [API Architecture](#api-architecture)
  - [AI-Assisted Development (Compound Engineering) 🤖](#ai-assisted-development-compound-engineering-)
  - [Contributing 🤝](#contributing-)
  - [User Stories:](#user-stories)
  - [User Features:](#user-features)
    - [Registration and Authentication:](#registration-and-authentication)
    - [Main Dashboard:](#main-dashboard)
    - [Destination Search:](#destination-search)
    - [Accessing Profile Information:](#accessing-profile-information)
    - [Profile User Overview:](#profile-user-overview)
    - [Favorite Trips and Packs:](#favorite-trips-and-packs)
    - [Profile Management:](#profile-management)
    - [Appearance Theme Customization:](#appearance-theme-customization)
    - [Profile Editing:](#profile-editing)
  - [Pack Features:](#pack-features)
    - [Pack Creation and Access Settings:](#pack-creation-and-access-settings)
    - [Adding Items to Packs:](#adding-items-to-packs)
    - [Pack Scoring System:](#pack-scoring-system)
    - [Navigating to the Dashboard:](#navigating-to-the-dashboard)
  - [Trip Features:](#trip-features)
    - [Trip Creation and Management:](#trip-creation-and-management)
    - [Setting up a Trip:](#setting-up-a-trip)
    - [Accessing Saved Trips:](#accessing-saved-trips)
    - [Viewing Trip Details:](#viewing-trip-details)
  - [Items Feature:](#items-feature)
    - [Dashboard:](#dashboard)
    - [Adding Items:](#adding-items)
  - [Feed Feature:](#feed-feature)
    - [Exploring Backpackers:](#exploring-backpackers)
    - [Pack List Interaction:](#pack-list-interaction)
    - [Item Management:](#item-management)
    - [Returning to Feed Dashboard:](#returning-to-feed-dashboard)
  - [👏 Special Thanks](#-special-thanks)
  - [License 📝](#license-)

## Overview 🌐

With **PackRat**, you can:

- Create and manage trips.
- Discover new destinations.
- Stay informed with up-to-date weather forecasts.
- Access accurate maps and directions with our integration to Mapbox.
- Get suggestions for popular outdoor activities based on your trip's location and season.

So pack your bags, grab your friends, and get ready for your next adventure with **PackRat**!

## Documentation 📚

> [!WARNING]
> While the app is in alpha, please be aware that there may be bugs or issues. We appreciate your patience and support as we work to improve the app. Data may be lost or corrupted during this time, so please use the app with caution. Thank you for your understanding and cooperation.

[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://raw.githubusercontent.com/PackRat-AI/PackRat/main/docs/ "Go to project documentation")

[![view - Testing Guide](https://img.shields.io/badge/view-Testing_Guide-green?style=for-the-badge)](https://raw.githubusercontent.com/PackRat-AI/PackRat/main/docs/testing.md "Go to testing documentation")

</div>

## Features 🚀

- Create and manage trips: users can create new trips and manage existing ones by adding details such as dates, locations, and activities.
- Map integration: PackRat integrates with Mapbox to provide users with accurate maps and directions to their destinations.
- Activity suggestions: the app suggests popular outdoor activities based on the location and season of the trip.
- Packing list: users can create and manage packing lists for their trips to ensure they have everything they need.
- Pack templates: users can save and reuse pack configurations for common trip types.
- Weather forecast: PackRat provides up-to-date weather forecasts for the trip location to help users prepare accordingly.
- Trail conditions: users can report and browse real-time trail condition updates from the community.
- AI assistant: an AI-powered chat assistant provides gear advice, trip suggestions, and more.
- Weight analysis: users can analyze their pack weight breakdown by category.
- Season suggestions: the app recommends gear and activities based on the trip's location and time of year.
- User authentication: the app uses user authentication to ensure privacy and data security.

## Technologies used 💻

PackRat is built using the following modern technologies:

- **React Native + Expo**: Cross-platform mobile development with Expo Router
- **Next.js**: Server-side rendering for web applications (landing page and guides)
- **Hono.js**: Fast, lightweight web framework running on Cloudflare Workers
- **PostgreSQL + Drizzle ORM**: Type-safe database operations with Neon serverless database
- **Jotai + TanStack Query**: Modern state management and data fetching
- **AI SDK + OpenAI**: AI-powered features and content generation
- **Bun**: Fast JavaScript runtime and package manager
- **Biome**: Modern linting and formatting toolchain
- **TypeScript**: Full type safety across the entire stack
- **Tailwind CSS + NativeWind**: Utility-first styling for web and mobile
- **Mapbox**: Location data platform for mobile and web applications

## 🗂 Folder layout

The main folders are:

- **`apps/`** - Applications
  - `expo/` - React Native mobile app with Expo Router
    - `app/` - App router screens and layouts
    - `features/` - Feature-based modules (auth, packs, etc.)
    - `components/` - Reusable UI components
    - `atoms/` - Jotai atoms for global state
    - `providers/` - React context providers
    - `lib/` - Utility libraries and configurations
    - `assets/` - Images, fonts, and other static assets
  - `landing/` - Next.js landing page website
  - `guides/` - Next.js documentation and guides site

- **`packages/`** - Shared packages across apps
  - `api/` - Hono.js API server running on Cloudflare Workers
    - `src/` - Source code with routes, middleware, and services
    - `drizzle/` - Database schema and migrations
    - `test/` - API tests
  - `ui/` - Shared UI components and design system

## 🆕 Add new dependencies

### Pure JS dependencies

For pure JavaScript libraries that work across all platforms (mobile, web, API):

```sh
# Install in the root to share across all apps
bun add lodash

# Or install in specific package if only used there
cd packages/api
bun add dayjs
```

These dependencies work without platform-specific code and can be safely used in any JavaScript environment.

### Native dependencies

For React Native modules that require platform-specific code (Android/iOS):

```sh
cd apps/expo
bun add react-native-reanimated

# Don't forget to rebuild after adding native dependencies
bun --cwd apps/expo run expo prebuild --clean
```

Native dependencies often require additional configuration and may need platform-specific setup. Always check the library's installation guide for React Native.

### Mobile app dependencies

For React Native dependencies, install them in the Expo app:

```sh
cd apps/expo
bun add react-native-reanimated
```

### API dependencies

For API/server dependencies:

```sh
cd packages/api
bun add hono
```

### Web app dependencies

For Next.js apps (landing/guides):

```sh
cd apps/landing  # or apps/guides
bun add next
```

## Dependency management

Use ManypKG to check for dependency issues across the monorepo:

```sh
bun check:deps
bun fix:deps
```

## Local installation 📲

PackRat is a modern monorepo with mobile, web, and API applications. Follow the steps below to install and run the applications.

### Dependencies

- [Bun](https://bun.sh) - Primary package manager and runtime
- [Node.js](https://nodejs.org/) - Required for some tooling
- [Expo CLI](https://docs.expo.io/workflow/expo-cli/) - For mobile development
- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/) - For API deployment
- [GitHub CLI](https://cli.github.com/) - For authenticating with GitHub packages

### GitHub Packages Authentication

PackRat uses private packages from GitHub Package Registry. You need to authenticate to install dependencies:

#### Local Development

1. Install GitHub CLI:

```bash
   # macOS
   brew install gh

# Windows
   winget install --id GitHub.cli

# Linux - see https://github.com/cli/cli#installation
   ```

2. Authenticate with GitHub CLI:

```bash
   gh auth login
   ```

3. Add the `read:packages` scope to your authentication:

```bash
   gh auth refresh -h github.com -s read:packages
   ```

4. Dependencies will now install automatically:
   ```bash
   bun install
   ```

> **Note**: The `preinstall` script automatically configures GitHub authentication using the GitHub CLI token. The script maps your GitHub CLI token to `PACKRAT_NATIVEWIND_UI_GITHUB_TOKEN` which is used by `bunfig.toml` for package authentication.

#### CI/CD

For GitHub Actions and other CI platforms:

1. Create a Personal Access Token (PAT) with `read:packages` scope
2. Add it as a secret named `PACKRAT_NATIVEWIND_UI_GITHUB_TOKEN` in your repository settings
3. Pass it as an environment variable in your workflow:
   ```yaml
   - name: Install dependencies
     env:
       PACKRAT_NATIVEWIND_UI_GITHUB_TOKEN: ${{ secrets.PACKRAT_NATIVEWIND_UI_GITHUB_TOKEN }}
     run: bun install
   ```

> **Note**: The default `GITHUB_TOKEN` provided by GitHub Actions does not have access to packages in other repositories, even within the same organization. A custom PAT is required.

### Environment Setup

1. Clone the repository:
   HTTPS:

```bash
git clone https://github.com/PackRat-AI/PackRat.git
```

SSH:

```bash
git clone git@github.com:PackRat-AI/PackRat.git
```

2. Navigate to the `PackRat` directory:

```
cd PackRat
```

3. Set up environment variables:

This project uses a centralized environment configuration strategy. All environment variables are defined in a single source of truth (e.g. .env.local) located at the root of the project.

A .dev.vars file will be automatically generated for development tools.

Run bun install to regenerate .dev.vars whenever environment variables are changed.

Optional: if you use direnv, copy `.envrc.example` to `.envrc` to auto-load `.env.local` in your shell. `.envrc` is ignored because it is local machine behavior.

AI-backed API features prefer Cloudflare AI Gateway when `CLOUDFLARE_ACCOUNT_ID`, `CLOUDFLARE_AI_GATEWAY_ID`, and `CLOUDFLARE_API_TOKEN` are all present. Direct provider keys such as `OPENAI_API_KEY`, `GOOGLE_GENERATIVE_AI_API_KEY`, and `PERPLEXITY_API_KEY` are still required for fallback and rollback.

See `docs/runbooks/ai-gateway-unified-billing.md` for production setup, fallback behavior, and provider coverage.

Only variables prefixed with PUBLIC\_ will be bundled into the Expo app (e.g., PUBLIC_API_URL). These are safe to expose in the client environment.

⚠️ Do not include secrets (e.g., private API keys) in PUBLIC\_ variables — they may be exposed in the bundled app.

### Git Hooks Setup

PackRat uses Lefthook for git hooks to ensure code quality. The hooks are automatically installed when you run `bun install`.

- **Pre-commit hook**: Runs `bun check` on staged files to enforce linting before every commit
- **Configuration**: See `lefthook.yml` in the root directory

If you need to skip hooks temporarily, use:

```bash
git commit --no-verify
```

### Installation & Development

#### Install dependencies

From the root directory:

```bash
bun install
```

#### Running the applications

You can run each application independently:

**Mobile App (Expo):**

```bash
# Start Expo development server
bun expo

# Or run directly on device/simulator
bun android  # for Android
bun ios       # for iOS
```

**API Server:**

```bash
# Start API in development mode
bun api
```

**Landing Page:**

```bash
cd apps/landing
bun dev
```

**Guides Site:**

```bash
cd apps/guides
bun dev
```

#### Development workflow

For mobile development, you'll typically run:

```bash
# Terminal 1: Start the API
bun api

# Terminal 2: Start the mobile app
bun expo
```

### Debugging 🐛

#### Common Issues

**Expo/Mobile App Issues:**

```bash
# Doctor check for Expo setup
bun --cwd apps/expo expo doctor

# Fix dependencies
bun --cwd apps/expo run expo install --fix

# Clean build
bun --cwd apps/expo run expo prebuild --clean

# Clear cache
bun expo --clear
```

**Dependency Issues:**

```bash
# Check monorepo dependencies
bun check:deps

# Fix dependency mismatches
bun fix:deps

# Clean and reinstall
bun clean
bun install
```

**API/Cloudflare Issues:**

- Check that your `wrangler.jsonc` is configured correctly in `packages/api/`
- Ensure your Cloudflare environment variables are set
- Use `bun api` to start the development server locally

### Code Quality

PackRat uses modern tools for code quality and consistency:

```bash
# Format all code
bun format

# Lint and fix issues
bun lint

# Type checking
bun check-types

# Check dependency consistency
bun check:deps
```

The project uses [Lefthook](https://github.com/evilmartians/lefthook) for git hooks - these run automatically on push to ensure code quality.

## API Architecture

The PackRat API is built with:

- **Hono.js** - Fast, lightweight web framework
- **Cloudflare Workers** - Serverless edge computing platform
- **Drizzle ORM** - Type-safe database operations
- **PostgreSQL** - Database hosted on Neon
- **OpenAI integration** - AI-powered features

See `packages/api/` for the complete API implementation.

## AI-Assisted Development (Compound Engineering) 🤖

PackRat ships a [Compound Engineering](https://compound.engineering) plugin for GitHub Copilot. This gives every contributor access to a set of specialized AI agents and reusable skills that accelerate the full development cycle — from ideation through planning, implementation, review, and documentation.

### How it works

The plugin installs:

| Path | What it contains |
|------|-----------------|
| `.github/agents/` | 29 specialist agent personas (security, architecture, performance, etc.) |
| `.github/skills/` | 45+ reusable slash-command workflows |
| `.github/copilot-mcp-config.json` | MCP server config (Context7 for live docs lookup) |

### Core workflow

The `/lfg` (Let's F*** Go) command runs the full autonomous engineering cycle in one shot:

```
/lfg <feature description>
```

Or run the individual steps manually:

| Command | Description |
|---------|-------------|
| `/ce:ideate [area]` | Generate ranked improvement ideas |
| `/ce:brainstorm <idea>` | Explore requirements and write a feature brief |
| `/ce:plan <description>` | Transform a brief into a structured implementation plan |
| `/ce:work <plan file>` | Execute a plan — ship the feature |
| `/ce:review [PR / branch]` | Multi-agent exhaustive code review |
| `/ce:compound` | Document a just-solved problem to compound team knowledge |
| `/ce:compound-refresh` | Refresh stale docs after refactors or upgrades |
| `/setup` | Interactive wizard to configure which agents run for this project |

### Specialist agents

Agents are invoked automatically based on context, or explicitly:

| Agent | Purpose |
|-------|---------|
| `security-sentinel` | OWASP / auth / secrets audits |
| `architecture-strategist` | Pattern compliance, service boundaries |
| `performance-oracle` | Latency, bundle size, query optimisation |
| `data-integrity-guardian` | Migration safety, schema drift |
| `design-implementation-reviewer` | Figma ↔ code fidelity |
| `kieran-typescript-reviewer` | TypeScript idioms and type safety |
| `dhh-rails-reviewer` | Rails conventions |
| `lint` | Automated linting agent |
| …and 21 more | See `.github/agents/` |

### Useful one-off skills

```
/ce:ideate              # What should we build next?
/reproduce-bug          # Minimal repro from a bug report
/triage                 # Prioritise an issue backlog
/changelog              # Generate a changelog entry
/feature-video          # Record a walkthrough of a feature
/proof                  # Share a doc via Proof for async review
```

For the full list run `/ce:help` in Copilot Chat, or browse `.github/skills/`.

## Contributing 🤝

> [!TIP]
> We have an active community of contributors and users who are happy to help. Join us on Discord to get involved!

Contributions to PackRat are welcome! To contribute, follow these steps:

1. Clone this repository.
2. Create a new branch.
3. Make your changes and commit them.
4. Push your changes to the remote branch.
5. Open a pull request.
6. Wait for your pull request to be reviewed and merged.
7. Celebrate! 🎉

## User Stories:

<details>
<summary><b>User Stories 📖</b> (Click to expand)</summary>

## User Features:

### Registration and Authentication:

- Users can create an account by accessing the menu and selecting the 'Register' option. Additionally, they have the option to sign up directly from the login page.

### Main Dashboard:

- On the main page, users have several options to choose from:
- Quick actions
- Search for new trails
- Access other menu options
- View their feed, which displays previously created packs.
- Users can search for a destination directly on the main dashboard, which will then redirect them to the maps interface.

### Destination Search:

- Users have the capability to search for a destination directly on the main dashboard.
- Upon initiating a search, users are redirected to the maps interface for further exploration and planning.

### Accessing Profile Information:

- Users can conveniently access their profile information from the menu under the Profile feature.

### Profile User Overview:

- The dashboard provides users with a comprehensive overview of their profile.
- It prominently displays the user's username and account photo for quick identification.

### Favorite Trips and Packs:

- Users have immediate access to their favorite trips and packs directly from the dashboard.
- By selecting the "View details" option, users can delve into more details about their favorite trips and packs.

### Profile Management:

- Users can effortlessly manage their profile information from the dashboard.
- By clicking on the settings button icon, users are directed to the profile settings section where they can make necessary updates seamlessly.

### Appearance Theme Customization:

- Users have the option to personalize their experience by changing the theme.
- They can choose between light mode or dark mode based on their preference.
- Additionally, users have the option to purchase additional themes for further customization. (Note: This feature may require updates.)

### Profile Editing:

- Users can easily edit their profile settings by clicking the "show dialog" option.
- This allows them to update their name and “food preferences”, with a wide range of options to choose from. (Note: This feature may require updates.)

## Pack Features:

### Pack Creation and Access Settings:

- Users are prompted to input a name for their pack when creating it.
- Users have the option to choose the accessibility setting for their pack, deciding whether it will be public or private.

### Adding Items to Packs:

- When users add an item to the pack, they are required to provide:
- The name of the item.
- The weight of the item.
- The quantity of the item.
- The category the item belongs to (food, water, essentials).
- After providing the necessary details, users click "Add Item" to include it in the pack dashboard.

### Pack Scoring System:

- Users can view their pack score, which is generated based on several criteria:
- The total weight of the pack.
- The presence of essential items.
- The degree of redundancy in items.
- The versatility of the items included.

### Navigating to the Dashboard:

- Users can easily return to the dashboard by following these steps:

1. Access the menu.
2. Select the "Home" option.

## Trip Features:

### Trip Creation and Management:

- Users have two methods for creating a trip:
- Directly from the main page dashboard using the quick actions feature.
- By navigating to the 'Trips' option in the menu.

### Setting up a Trip:

- Users initiate trip setup by selecting their backpacking destination.
- Nearby trails and parks are displayed for exploration.
- Users can:
- Choose gear from their saved packs.
- Create a new pack and add items directly on the page.
- Select the target date for their trip using a calendar to specify the duration.
- A map showcasing the trip destination is provided for reference.
- Once all details are confirmed, users:
- Save their trip.
- Input a name and description.
- Choose the trip's accessibility setting (public or private).
- A weather forecast and summary of the destination, trails, dates, and trip duration are displayed for easy reference.

### Accessing Saved Trips:

- Users can easily access their saved trips from the menu by selecting the 'Trips' option.
- Within the 'Trips' section, users can:
- Organize their trips by sorting them from favorites to most recent.
- Utilize a search bar to quickly locate a specific trip by name.

### Viewing Trip Details:

- When users select a trip from the dashboard, they are presented with detailed information including:
- The trip's description.
- Destination.
- Start and end dates.
- Additionally, users can:
- Conveniently view the weather forecast for the selected dates directly on the same page.
- Access the maps interface for further exploration.
- At the bottom of the page, users can find the Trip Score, providing an overall assessment of the trip's suitability and preparedness.

## Items Feature:

### Dashboard:

- Users are able to view their items used in their saved packs.
- They can sort how many items will show up on screen. They can choose from 10, 20, and 50.
- Users have the option to add new items.

### Adding Items:

- User needs to fill out the following fields:
- Item Name
- Weight – they can choose the unit of measurement. Includes lb, kg, oz, and g.
- Quantity
- Category

## Feed Feature:

### Exploring Backpackers:

- Users can browse through a list of other backpackers.
- Navigate the page using the search and sort options.

### Pack List Interaction:

- Upon opening a pack list, users have several options available:
- They can view the profile of the backpacker associated with the pack.
- Users also have the ability to copy the pack list for their own use.
- The pack list includes detailed information such as item name, weight, quantity, and category.

### Item Management:

- Users can interact with items on the pack list by:
- Editing, deleting, or ignoring items as needed.
- The total weight of the pack is dynamically calculated and displayed at the bottom of the page.
- Users can easily add new items to the pack list as well.
- At the bottom of the page, users can view the Pack Score.

### Returning to Feed Dashboard:

- Users can navigate back to the feed dashboard by accessing the menu and selecting the "feed" option.

</details>

## 👏 Special Thanks

- [React Native Developers](https://twitter.com/reactnative)
- [OpenStreetMap Developers](https://www.openstreetmap.org/)
- [RN MapBox Developers](https://github.com/rnmapbox/maps)
- [Cloudflare Developers](https://twitter.com/CloudflareDev)
- [Yusuke Wada](https://twitter.com/yusukebe) - Creator of Hono.js
- [Nate Birdman](https://twitter.com/natebirdman) - Creator of Tamagui
- [Fernando Rojo](https://twitter.com/fernandotherojo) - Creator of Zeego
- [Tanner Linsley](https://twitter.com/tannerlinsley) - Creator of TanStack
- [Timothy Miller](https://twitter.com/ogtimothymiller) - Creator of T4 Stack
- [Expo Developers](https://twitter.com/expo) - Office hours
- [Shopify Developers](https://twitter.com/ShopifyDevs)

## License 📝

PackRat is licensed under the terms of the [GNU General Public License v3.0](LICENSE). See `LICENSE` for more information.

PackRat

PackRat 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

PackRat

PackRat 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README