Pars en Cours - Student Transportation App

A React Native Expo TypeScript app for connecting students in need of transportation with those who can help, featuring Nostr integration, location-based posts, and real-time messaging.

🚀 Project Overview

Pars en Cours (French for "Go To Class") is a decentralized student transportation assistance app that enables students to request help and allows anyone to offer assistance. The app features a Nostr protocol integration, privacy-preserving location sharing, real-time messaging, and full internationalization support.

✨ Features

Core Features

Multi-User Type Support - Students can both ask for help and offer assistance; non-students can only offer help
Interactive Map Interface - Mapbox-powered map with real-time location services and privacy controls
Comprehensive Onboarding - 3-step onboarding process with Nostr key generation/import
Floating Action Button - Context-aware expandable button with different options based on user type
Nostr Integration - Full decentralized identity and data management using Nostr protocol
Real-time Messaging - NIP-04 encrypted direct messages with conversation management
Location-Based Posts - Privacy-preserving geohash implementation for approximate location sharing
Post Management - Create, view, and manage transportation requests and offers (NIP-99 classified listings)
Internationalization - Complete English and French language support with automatic device detection
Theme System - Light, dark, and auto theme modes with system preference detection

Technical Features

TypeScript - Full type safety with comprehensive interfaces
React Navigation - Bottom tabs and stack navigation
Mapbox Integration - Professional mapping with custom styling
Nostr Protocol - Decentralized identity and data management with custom RelayManager
Location Services - GPS with privacy controls and geohash
State Management - Context + useReducer for complex state
Custom Hooks - Reusable logic for auth, location, Nostr, messaging, and listings
Form Validation - Complete validation system
AsyncStorage - Local data persistence with caching
Real-time Subscriptions - Live updates for messages

📁 Project Structure

src/
├── components/
│   ├── AppContent.tsx       # Main app wrapper with status bar
│   └── common/              # Reusable UI components
│       ├── Button.tsx       # Multi-variant button with loading states
│       ├── Input.tsx        # Form input with validation
│       ├── CustomAlert.tsx  # Custom alert modal system
│       ├── Dropdown.tsx     # Dropdown selection component
│       ├── FloatingActionButton.tsx # Context-aware expandable FAB
│       ├── QRCodeModal.tsx  # QR code display for Nostr keys
│       └── index.ts         # Component exports
├── screens/
│   ├── OnboardingScreen.tsx # 3-step onboarding with Nostr setup
│   ├── MapScreen.tsx        # Mapbox-powered interactive map
│   ├── MessagesScreen.tsx   # Messages interface (placeholder)
│   ├── ProfileScreen.tsx    # User profile with QR code
│   ├── ProfileEditScreen.tsx # Profile editing interface
│   └── SettingsScreen.tsx   # App settings and preferences
├── navigation/
│   ├── RootNavigator.tsx    # Root navigation with auth flow
│   ├── MainStackNavigator.tsx # Main app stack navigation
│   └── BottomTabNavigator.tsx # Bottom tab navigation
├── context/
│   ├── AppContext.tsx       # Global state with useReducer
│   └── ThemeContext.tsx     # Theme management (light/dark/auto)
├── hooks/
│   ├── useAuth.ts           # Authentication and user management
│   ├── useLocation.ts       # Location services and permissions
│   ├── useNostrProfile.ts   # Nostr profile management
│   ├── useRelays.ts         # Nostr relay management
│   ├── useCustomAlert.ts    # Custom alert system
│   ├── useMessages.ts       # NIP-04 direct messaging with real-time subscriptions
│   ├── useListings.ts       # NIP-99 classified listings management
│   ├── useBookmarks.ts      # Bookmark management
│   └── index.ts             # Hook exports
├── i18n/
│   ├── index.ts             # i18next configuration with device detection
│   ├── hooks.ts             # Translation hooks
│   ├── locales/
│   │   ├── en.json          # English translations
│   │   └── fr.json          # French translations
│   └── README.md            # Localization documentation
├── services/
│   └── RelayManager.ts      # Centralized Nostr relay connection management
├── types/
│   └── index.ts             # Comprehensive TypeScript definitions
└── utils/
    ├── nostr.ts             # Nostr key generation and validation
    ├── nip04.ts             # NIP-04 encryption/decryption for direct messages
    ├── giftwrap.ts          # NIP-59 gift wrap implementation (future)
    ├── encryption.ts        # Additional encryption utilities
    ├── geohash.ts           # Privacy-preserving location utilities
    ├── validation.ts        # Form validation helpers
    ├── time.ts              # Time formatting utilities
    ├── deletion.ts          # Post deletion utilities (NIP-09)
    ├── dmRelays.ts          # Direct message relay management
    └── index.ts             # Utility exports

🛠 Tech Stack

React Native + Expo + TypeScript
Mapbox + Nostr Protocol + i18next

🚀 Getting Started

Prerequisites

Node.js (v20.11.1 or higher)
npm or yarn
Expo CLI
iOS Simulator or Android Emulator (or Expo Go app)

Installation

Clone the repository

git clone https://github.com/kn9w/pars_en_cours.git
cd pars_en_cours

Set up environment variables

cp env.example .env
# Edit .env with your Mapbox tokens (get them from https://account.mapbox.com/access-tokens/)

Install dependencies
```
npm install
```
Start the development server
```
npm start
# or
expo start
```
Run on device/simulator
- iOS: npm run ios or scan QR code with Camera app
- Android: npm run android or scan QR code with Expo Go
- Web: npm run web

Alternative: Development Without Mapbox

For faster development without Mapbox dependencies:

npm run start:no-mapbox

📱 App Screens

Onboarding

3-step process for user type selection, feature introduction, and Nostr key generation/import with smooth animations.

Map

Interactive Mapbox map with real-time location, color-coded markers for posts, geohash privacy, and tap-to-create functionality.

Messages & Conversations

NIP-04 encrypted direct messaging with real-time updates, conversation threads, and automatic profile loading.

Create Post

Form for creating "Ask" or "Give" posts with category selection, location services, configurable geohash precision, and image support.

Post Detail

Full post view with author profile, image carousel, action buttons (contact, bookmark, share), and delete option for post owners.

Profile

User's own Nostr profile with QR code sharing, settings access, and profile editing capabilities.

User Profile

View other users' public profiles with bio, recent posts, and quick contact button.

Bookmarks

Manage saved posts with pull-to-refresh and easy removal.

Settings

Relay management, theme selection (light/dark/auto), language switching, and account settings.

🔧 Key Components

UI Components

FloatingActionButton - Context-aware expandable button (Ask/Give options)
Button - Multi-variant button with loading states and icons
CustomAlert - Themed modal system replacing native alerts
QRCodeModal - Nostr key sharing with copy functionality
PostCard - Listing display component with image support
ProfileName - Reusable profile name display with caching
SkeletonLoader - Loading state components
Input - Form input with validation
Dropdown - Dropdown selection component
AppIcon - Custom app icon component

Custom Hooks

useAuth - Authentication and user management
useMessages - NIP-04 direct messaging with real-time subscriptions
useListings - NIP-99 classified listings management
useRelays - Nostr relay configuration management
useLocation - Location services and permissions
useNostrProfile - User's own Nostr profile management
useUserProfile - Other users' profiles with smart caching
useBookmarks - Bookmark management with AsyncStorage
useCustomAlert - Custom alert system

Services

RelayManager - Centralized WebSocket connection management for Nostr relays with automatic reconnection

🔒 Privacy Features

Geohash Location: Truncated coordinates for approximate location sharing
Optional Location: Users control when and how location is shared
Nostr Decentralization: No central authority controls user data
Key Management: Users control their own cryptographic keys
NIP-04 Encryption: End-to-end encrypted direct messages
No Data Collection: App doesn't collect personal data centrally
Local Storage: Messages and profiles cached locally with AsyncStorage

Completed Features ✅

🤝 Contributing

We welcome contributions from the community! Here's how you can help make Pars en Cours better:

🚀 Quick Start for Contributors

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/kn9w/pars_en_cours.git
cd pars_en_cours

Set up environment variables:

cp env.example .env
# Edit .env with your Mapbox tokens

Install dependencies:
```
npm install
```
Start development:
```
npm start
```

🐛 Reporting Issues

Use the Issues tab to report bugs
Search existing issues before creating new ones
Include steps to reproduce, expected behavior, and screenshots if applicable
Use issue templates when available

💡 Suggesting Features

Open a Feature Request issue
Describe the feature and its use case
Explain how it aligns with the project's goals

Pull Request Process

Create a feature branch: git checkout -b feature/your-feature-name
Make your changes with clear, focused commits
Test thoroughly on both Android and iOS if possible
Update documentation if needed
Submit a pull request with:
- Clear description of changes
- Screenshots/videos for UI changes
- Reference to related issues

🌍 Translation Contributions

Help make the app accessible worldwide! See our Translation Guide for details.

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Connecting students in need of transportation with those who can help

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
.github/workflows		.github/workflows
assets		assets
docs		docs
scripts		scripts
src		src
.gitignore		.gitignore
App.tsx		App.tsx
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
app.config.ts		app.config.ts
app.json		app.json
babel.config.js		babel.config.js
eas.json		eas.json
env.example		env.example
index.js		index.js
metro.config.js		metro.config.js
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

Folders and files

Latest commit

History

Repository files navigation

Pars en Cours - Student Transportation App

🚀 Project Overview

✨ Features

Core Features

Technical Features

📁 Project Structure

🛠 Tech Stack

🚀 Getting Started

Prerequisites

Installation

Alternative: Development Without Mapbox

📱 App Screens

Onboarding

Map

Messages & Conversations

Create Post

Post Detail

Profile

User Profile

Bookmarks

Settings

🔧 Key Components

UI Components

Custom Hooks

Services

🔒 Privacy Features

Completed Features ✅

🤝 Contributing

🚀 Quick Start for Contributors

🐛 Reporting Issues

💡 Suggesting Features

Pull Request Process

🌍 Translation Contributions

📄 License

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages