Area

An automation platform that connects different services through action-reaction workflows. Think IFTTT but self-hosted.

Live Demo • API Documentation

Note

Automatically deployed to Render via GitHub Actions on every push to main

What it does

Area lets you create automation rules (called "applets") by connecting triggers (actions) from one service to responses (reactions) in another. When an action's condition is met, its paired reactions execute automatically.

Examples:

• Post to Discord when you push to GitHub
• Send an email when the weather changes
• Add a Spotify song to a playlist when you favorite a track
• Create a Todoist task when a new GitHub issue is opened

Supported Services

20+ Integrated Services

Category	Services
Social	Discord, Reddit, Twitch, LinkedIn
Development	GitHub, Figma, Notion
Cloud Storage	Dropbox
Music & Media	Spotify, YouTube, Podcast, Trakt
Productivity	Google Calendar, Gmail, Outlook, Todoist
Fitness	Strava, Clash Royale
Weather	OpenMeteo
Utilities	Email, Date/Time triggers, IGN

Architecture

The project is fully containerized with Docker Everything runs in Docker containers for development and production.

Components

Component	Technology	Description
Backend	FastAPI	Service-based automation system with cron-triggered actions
Frontend	Next.js	Visual workflow builder for creating applets
Mobile	Flutter	Cross-platform mobile app (APK distributed via shared volume)
Database	PostgreSQL	Data persistence for users, services, and automations

How it works

graph LR
    A[Actions] -->|Check Conditions| B[Cron Jobs]
    B -->|Trigger| C[Reactions]
    C -->|Execute| D[Service APIs]
    E[OAuth] -->|Authenticate| A
    E -->|Authenticate| C

Loading

1. Actions check conditions periodically (configured cron intervals)
2. Reactions execute when their paired action triggers
3. Cron jobs are dynamically created/deleted based on enabled areas
4. OAuth flows handle service authentication for both web and mobile

Quick Start

Important

Prerequisites:

• Docker & Docker Compose
• Git

Running the Application

1. Configure environment variables

   Copy the example files and fill in your OAuth credentials:

   cp server/.env.example server/.env
   cp frontend/.env.example frontend/.env
   cp frontend/.env.prod.example frontend/.env.prod

   [!TIP] See the Configuration section for details on getting OAuth credentials.

2. Start all services

   docker compose up --build

   This will start:

   • Frontend: http://localhost:8081
   • Backend API: http://localhost:8080
   • PostgreSQL: localhost:5432
   • Mobile APK builder: Outputs to shared volume

3. Access the application

   • Web: Navigate to http://localhost:8081
   • Mobile: Download APK from http://localhost:8081/client.apk endpoint

Configuration

Warning

The application requires OAuth credentials for each service you want to use. Copy the .env.example files and configure them with your credentials.

Backend Configuration (server/.env)

See server/.env.example for all available options. Key sections:

Core Settings

POSTGRES_USER=area_user
POSTGRES_PASSWORD=your_secure_password
POSTGRES_DB=area_db
JWT_SECRET=your_jwt_secret_key_here
FRONT_URL=http://localhost:8081

OAuth Credentials

You'll need to create OAuth apps for each service:

Service	Developer Portal	Required Scopes
GitHub	https://github.com/settings/developers	repo, user:email
Google	https://console.cloud.google.com/	calendar, gmail
Microsoft	https://portal.azure.com/	mail.read, calendars.read
Discord	https://discord.com/developers/applications	bot
Spotify	https://developer.spotify.com/dashboard	user-read-playback-state
Reddit	https://www.reddit.com/prefs/apps	read, identity
Twitch	https://dev.twitch.tv/console	user:read:email
...	...	email

Tip

See .env.example for the complete list of configuration options

Add credentials to server/.env:

GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret
SPOTIFY_CLIENT_ID=your_spotify_client_id
SPOTIFY_CLIENT_SECRET=your_spotify_client_secret
# ... etc for each service

Frontend Configuration (frontend/.env)

BACKEND_URL=http://backend:8080

Frontend Configuration (frontend/.env.prod)

BACKEND_URL=http://server:8080

For production deployment, change to your backend URL.

Development

Docker-First Approach

Tip

Everything runs in Docker. Services are never run directly on the host machine (except for tests and linting).

Development Workflow

Development Environment	Production Environment
docker compose -f ./docker-compose.dev.yml up --build	docker compose up --build

Testing & Linting

Tip

Tests and linting are run outside Docker in CI/CD pipelines.

Backend Tests & Linting

PyTest:

docker compose -f ./docker-compose.test.yml up --build
cd server
pip install -r requirements.txt
pytest -v --cov app/tests/

Flake8:

cd server
flake8 . --count --max-line-length=79

Frontend Tests & Linting

Jest:

cd frontend
npm install
npm run test

ESLint:

cd frontend
npm run lint

Mobile Linting

Flutter:

cd mobile
flutter analyse

Docker Compose Files

File	Purpose
docker-compose.yml	Production configuration
docker-compose.dev.yml	Development with hot-reload
docker-compose.test.yml	Testing environment with isolated database

Deployment

Note

The application is automatically deployed to Render when you push to the main branch.

Service	URL
Frontend	https://area-prod.onrender.com
Backend	https://area-prod-back.onrender.com

API Documentation

Once running, access the auto-generated API docs:

Documentation	URL
Swagger UI	http://localhost:8080/docs
ReDoc	http://localhost:8080/redoc

Troubleshooting

Database connection issues

# Recreate database
docker compose down -v
docker compose up --build

OAuth redirect issues

[!CAUTION] Ensure your OAuth app redirect URLs match:

• Web: http://localhost:8081/callbacks/{oauth_type}/{service}
• Mobile: Custom scheme configured in FRONT_URL

Port conflicts

If ports 8080/8081/5432 are in use, modify docker-compose.yml:

ports:
  - "____(any free port):3000"  # Change left side only

License

This is an Epitech school project (3rd year - 2025).

Contributors

See Git history for contributor information.