An open API service indexing awesome lists of open source software.

https://github.com/fabianlopezdev/usa-presence-calculator


https://github.com/fabianlopezdev/usa-presence-calculator

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# USA Presence Calculator

A premium mobile application for U.S. Lawful Permanent Residents to track their physical presence for naturalization eligibility.

## ๐Ÿš€ Project Structure

This is a monorepo project using pnpm workspaces:

- `mobile/` - React Native + Expo mobile application
- `api/` - NestJS backend API
- `shared/` - Shared types and validation schemas (Zod)

## ๐Ÿ› ๏ธ Prerequisites

- Node.js >= 18.0.0
- pnpm >= 8.0.0
- iOS Simulator (for iOS development)
- Android Studio (for Android development)

## ๐Ÿ“ฆ Installation

```bash
# Install dependencies
pnpm install

# Install git hooks
pnpm prepare
```

## ๐Ÿƒโ€โ™‚๏ธ Development

```bash
# Run all packages in development mode
pnpm dev

# Run specific package
pnpm --filter mobile dev
pnpm --filter api dev
```

## ๐Ÿงช Testing

```bash
# Run all tests
pnpm test

# Run tests for specific package
pnpm --filter mobile test
```

## ๐Ÿ“ Code Quality

```bash
# Run linting
pnpm lint

# Fix linting issues
pnpm lint:fix

# Check TypeScript types
pnpm typecheck

# Format code
pnpm format

# Check formatting
pnpm format:check
```

## ๐Ÿ”„ Git Workflow

This project uses conventional commits. All commits must follow the format:

```
type(scope): description

feat: new feature
fix: bug fix
docs: documentation changes
style: code style changes
refactor: code refactoring
test: test changes
chore: maintenance tasks
```

## ๐Ÿ“ฑ Features

- Track physical presence in the USA
- OCR scanning for flight tickets
- Travel simulator for planning
- Visual calendar with presence indicators
- PDF export for legal documentation
- Offline-first architecture
- Privacy-focused design

## ๐Ÿ” Security

- OAuth 2.0 authentication (Apple/Google)
- Biometric authentication
- Local data encryption
- No unnecessary data collection

## ๐Ÿ“„ License

Proprietary - All rights reserved