Getting Started

Set up the Everything App for local development in under 5 minutes.

Prerequisites

Tool	Version	Notes
Flutter SDK	≥ 3.10.0	Includes Dart ≥ 3.0.0
Android Studio / Xcode	Latest	For device emulators
Git	Any recent	For cloning the repo
Firebase CLI	Latest	Optional — for Firebase features

Installation

1. Clone the Repository

# Clone
git clone https://github.com/sauravbhattacharya001/everything.git
cd everything
    

2. Install Dependencies

flutter pub get

3. Run the App

# Run on connected device or emulator
flutter run

# Run on web
flutter run -d chrome

# Run on specific device
flutter devices          # List available devices
flutter run -d <device>
    

💡 Non-Firebase mode The app works without Firebase configured — auth features will be unavailable, but event management and local storage still function.

Firebase Setup (Optional)

To enable authentication features:

Create a project in the Firebase Console
Enable Email/Password authentication in the Authentication section
Register your app (Android: add google-services.json, iOS: add GoogleService-Info.plist)
For web: add Firebase config in web/index.html

Environment Variables

API keys should never be hardcoded. Use Dart's --dart-define mechanism:

# Run with API key
flutter run --dart-define=GOOGLE_API_KEY=your_key_here

# Or create a .env file (requires flutter_dotenv)
GOOGLE_API_KEY=your_key_here
    

Running with Docker

The repo includes a Dockerfile for containerized builds:

# Build the Docker image
docker build -t everything-app .

# Run it
docker run -p 8080:80 everything-app

# Or pull from GHCR
docker pull ghcr.io/sauravbhattacharya001/everything:latest
    

Project Structure

everything/
├── lib/
│   ├── main.dart                  # App entry + AuthGate widget
│   ├── core/
│   │   ├── constants/             # AppConstants (URLs, schemes, hosts)
│   │   ├── services/              # AuthService, EventService, GraphService
│   │   └── utils/                 # HttpUtils (SSRF-safe), DateUtils
│   ├── data/
│   │   ├── local_storage.dart     # SQLite singleton (v4 schema)
│   │   └── repositories/         # EventRepository, UserRepository
│   ├── models/
│   │   ├── event_model.dart       # EventModel + EventPriority enum
│   │   ├── event_tag.dart         # EventTag with color palette
│   │   ├── recurrence_rule.dart   # RecurrenceRule + frequency enum
│   │   └── user_model.dart        # UserModel
│   ├── state/
│   │   ├── blocs/                 # EventBloc (Cubit-based)
│   │   └── providers/             # EventProvider, UserProvider
│   └── views/
│       ├── home/                  # HomeScreen, EventDetailScreen, StatsScreen
│       ├── login/                 # LoginScreen
│       └── widgets/               # EventCard, EventFormDialog, UserAvatar
├── test/                          # Unit & widget tests
├── docs/                          # Documentation site (GitHub Pages)
├── .github/                       # CI, CodeQL, Docker, Pages workflows
├── pubspec.yaml                   # Dependencies
├── Dockerfile                     # Container build
└── CONTRIBUTING.md                # Contributor guide