🥁 Prelude

[MitchellShiell]

Prelude is a tool that enables teams to incrementally build their data platform. By breaking down data portal development into phased steps, teams can systematically verify requirements and user workflows while minimizing technical overhead.

Development Phases

Development progresses through four distinct phases, each building upon the
previous phase's foundation while introducing new capabilities.

Phase	Description	Software Components	Status
PhaseOne: Data Exploration & Theming	Display your tabular data in a themable portal with our front-end and back-end search components.	CSV-processor, Elasticsearch, Arranger, Stage	🟢 Working
PhaseTwo: Tabular Data Management & Validation	Implementation of tabular data submission, storage and validation.	All the above with Lyric, LyricDb (Postgres), Lectern and LecternDb (MongoDb) added	🟡 Pending
PhaseThree: File Data & Metadata Management	Implement back-end file management.	All the above with Song, Score, SongDb (Postgres) and Object Storage (Minio)	🔴 Requires fixes
PhaseFour: Identity and Access management	Configure Keycloak to authenticate users and authorize what they have access too.	Empahsis on data access control planning and Keycloak configuration	⚪ Not Started

Documentation

Detailed documentation can be found in multiple locations:

• The /docs folder at the root of this repository and within the docker-compose.yml
• README files within each root directory containing information on the folder's
  purpose and usage
• Frontend documentation available after deployment at
  http://localhost:3000/documentation

Next Steps

Conductor

• (1) createSongStudy command
• (2) SongSchemaUpload command
• songDataUpload command
• Indexing Command

Docker Composer

• Make platform (carrying over quickstart capabilities)
• Update conductor envs

Misc.

• Update phase one documentation with new config generation steps
• Investigate removal of scripts in place of more flexible js files
• Fix Song Swagger CORS issue