OpenParable
Skip to content
← Back to skills

Repo Navigation

Development
repo-navigation

Repo Navigation is an Agent Skill for development published in the fossasia/eventyay repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Repository layout and where to find code

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/fossasia/eventyay/blob/HEAD/.agents/skills/repo-navigation/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/repo-navigation, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: Repository Navigation

Top-level Layout

.
├── app/                    # Main Django application
├── deployment/             # Infrastructure and deployment configs
├── doc/                    # Project documentation
├── .github/instructions/   # File-scoped AI coding guidance
├── .agents/skills/         # AI agent skill files (this directory)
├── agents.md               # Canonical AI agent policy
├── docker-compose.yml      # Docker Compose for local/dev environment
├── DEPLOYMENT.md           # Production deployment walkthrough
├── CONTRIBUTING.md         # Contributor guidelines
└── README.rst              # Project overview

Application Root: app/

app/
├── eventyay/               # Core Django application package
├── tests/                  # Test suite
├── pyproject.toml          # Project metadata and dependencies
└── manage.py               # Django management entry point

Core Application: app/eventyay/ (selected directories)

DirectoryPurpose
api/REST API endpoints (Django REST Framework)
agenda/Agenda and timetable domain logic
base/Shared models (base/models/), utilities, middleware, and forms (base/forms/)
cfp/Call-for-proposals and review workflows
control/Organiser/back-office views, forms, and URLs
presale/Attendee-facing (ticket purchase) views and forms
orga/Organiser-facing event management flows and views
event/Event domain models and related business logic
common/Cross-cutting helpers shared across modules
config/Application configuration and settings
plugins/Plugin infrastructure
static/Static assets (CSS, JS, images)
jinja-templates/Jinja HTML templates
locale/Translation files
mail/Email rendering and sending
celery.py / celery_app.pyCelery task configuration

This table is intentionally non-exhaustive and focuses on high-traffic modules.

Note: Models, forms, and templates are distributed inside sub-apps (e.g. base/models/, control/forms/, presale/templates/), not in standalone top-level directories.

Deployment: deployment/

deployment/
├── docker-compose.yml      # Production Compose file
├── env.sample              # Sample environment variables
├── env.dev.sample          # Sample dev environment variables
└── nginx/                  # Nginx configuration

Documentation: doc/

Contains extended project documentation written in reStructuredText or Markdown.

Key Lookup Shortcuts

  • Add a model → app/eventyay/<sub-app>/models.py or app/eventyay/base/models/
  • Add an API endpoint → app/eventyay/api/
  • Add a form → app/eventyay/<sub-app>/forms.py or app/eventyay/<sub-app>/forms/
  • Add a migration → run python manage.py makemigrations from app/
  • Add a test → app/tests/