Skip to main content

Development

Project Structure

FolderDescription
packages/serverThe main repository server and API logic
packages/dbadminInitializes and configures the database schema
packages/commonShared utility functions
packages/bulkapiImplements the LionWeb Bulk API as per specification
packages/additionalapiImplements extra APIs outside the LionWeb spec
packages/inspectionAPIs to inspect repository contents
packages/languages(Placeholder) Future support for language management
packages/testAutomated tests for the core components

Building and Running

Build the code:

npm install
npm run build
npm run lint

Run the server:

cd packages/server
npm run dev-run

Ensure PostgreSQL is running and accessible before starting the server.

Run tests:

npm run test

🛠 Releasing

To publish a new release:

./scripts/tag-and-release-docker-image.sh

For detailed instructions, refer to scripts/README.md.