search

event-catalog / eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures
https://eventcatalog.dev
MIT License
1.75k stars 150 forks source link

Restructure package #713

Closed carlosallexandre closed 1 month ago

carlosallexandre commented 2 months ago

Today, the package repo structure seems a bit confusing.

Perhaps, we could rearrange to something like this:

.
├── astro             # All the files related to astro
│   └── ...                   
├── bin               # Files related with `eventcatalog` bin
│   ├── scripts          
│   └── ...                   
├── examples          # Catalog examples
│   ├── default          
│   └── ...                   
└── ...               # Other config files

This structure is more similar with what the user has, .eventcatalog-core and its catalog. This enable us to test the bin e2e. Currently, running npx . dev will raise an error that couldn't copy folder to a subdirectory of self.

Now, when creating the .eventcatalog-core at users dir all the files are copied from the package, with this structure just the astro dir is needed to be copied.