Skip to main content

Source: ebisu/docs/adr/0003-project-restructure.md | ✏️ Edit on GitHub

ADR 0001: Project Restructure for Future-Proofing

Status: Proposed

Context:

The project was recently moved from a subdirectory (ebisu-v1) to the root of the repository. This resulted in a flat structure with many top-level directories. As the project grows, this flat structure can become hard to navigate and maintain.

Decision:

To improve the project structure and make it more scalable, we will introduce a modular structure by grouping related components into backend and tools directories.

The new structure will be as follows:

ebisu/
├── backend/
│   ├── drizzle-schemas/
│   ├── import/
│   ├── import-sources/
│   ├── migrations/
│   └── scripts/
├── tools/
│   └── pg-schema-viewer/
├── docker/
├── docs/
│   └── adr/
│       └── 0001-project-restructure.md
...

Consequences:

  • The project structure will be more organized and easier to understand.
  • It will be easier to add new components to the project in the future without cluttering the root directory.
  • Some scripts and configuration files might need to be updated to reflect the new paths. This will be handled in separate tasks.