MaastrichtU-BISS / lawnotation

Legal text annotation platform for researchers, legal practioners and more!
https://lawnotation.org
Apache License 2.0
6 stars 1 forks source link

Project file structure #1

Closed eensander closed 11 months ago

eensander commented 1 year ago

This issue can be used to propose different possible file structures for this project. A solid tree structure can serve as a good foundation for a project and possibly prevent large changes at a later stage.

Since a monorepo-approach was considered, in which the both the backend and frontend code are available in the same repository, tied together by a docker-compose file, the start for the first proposed tree structure is as follows:

.
├── lawnotation/
│   └── services/
│       ├── frontend/
│       │   └── src/
│       └── backend/
│           ├── input/
│           ├── preprocessing/
│           ├── preannotating/
│           └── labelstudio_proxy/
├── docker/
│   ├── docker-compose.yml
│   └── volumes/
├── docs/
└── README.md

The top-level folder 'lawnotation' may or may not be analogous to services and therefore be redundant. This strategy is borrowed from how label-studio itself contains its collection of services (which is one level deep).

The idea of the docker folder with volumes is borrowed from supabase.

The docker-compose.yml file would probably contain a section for serving label-studio backend.

Any questions, comment or improvements regarding this first proposed file structure concept are welcome in this thread.

eensander commented 11 months ago

Since we've moved utilizing the monolithic functionalities of Nuxt (full-stack in Nuxt), the aforementioned proposal is not relevant anymore.