library-of-alexandria
Library of Alexandria (LoA in short) is a project that aims to collect and archive documents from the internet.
File Explorer
Download Latest Version (.zip)- gradle.yml
- checkstyle.xml
- ruleset.xml
- application-administration.adoc
- application-architectural-overview.adoc
- application-conductor.adoc
- application-downloader.adoc
- application-generator.adoc
- application-indexer.adoc
- application-parameters.adoc
- application-queue.adoc
- application-staging.adoc
- application-vault.adoc
- application-web.adoc
- application.adoc
- beacon-application.adoc
- architecture.svg
- logo-background.png
- architecture.drawio
- disc-usage.adoc
- domain.adoc
- installation-conductor-application.adoc
- installation-downloader-application.adoc
- installation-elasticsearch.adoc
- installation-generator-application.adoc
- installation-indexer-application.adoc
- installation-java.adoc
- installation-mongodb.adoc
- installation-queue-application.adoc
- installation-staging-application.adoc
- installation-vault-application.adoc
- installation-web-application.adoc
- installation.adoc
- prerequisites.adoc
- conductor-configuration.adoc
- system-requirements-collecting.adoc
- system-requirements-indexing.adoc
- system-requirements.adoc
- index.adoc
- gradle-wrapper.jar
- gradle-wrapper.properties
- CleanupCommand.java
- SilentCompressorConfigurationProperties.java
- SilentCompressorCommand.java
- DocumentRecollectorService.java
- RecollectCorruptDocumentsCommand.java
- SourceLocationRecrawlerService.java
- ReindexCommand.java
- RegisterUserConfigurationProperties.java
- RegisterUserCommand.java
- DocumentValidatorCommand.java
- AdministratorCommandConfigurationProperties.java
- AdministratorConfigurationProperties.java
- StageConfiguration.java
- AdministratorInstancePropertyExtensionProvider.java
- LibraryAdministratorApplication.java
- application-local.properties
- application.properties
- banner.txt
- DocumentRecollectorServiceTest.java
- SourceLocationRecrawlerServiceTest.java
- build.gradle
- OfflineDownloaderConfigurationProperties.java
- OfflineDownloaderStatisticsConfiguration.java
- OfflineDownloaderCommand.java
- BeaconConfigurationProperties.java
- StageConfiguration.java
- DocumentLocation.java
- DocumentLocationProcessingException.java
- DocumentLocationResult.java
- DocumentLocationProcessor.java
- DocumentLocationVisitor.java
- StoragePathFactory.java
- DocumentLocationPartialRequest.java
- VisitDocumentLocationsRequest.java
- DocumentLocationResultPartialResponse.java
- VisitDocumentLocationsResponse.java
- BeaconController.java
- LibraryBeaconApplication.java
- application-local.properties
- application.properties
- banner.txt
- build.gradle
- ConductorWebMvcConfigurer.java
- IndexDatabaseConfigurationProperties.java
- RepositoryConfigurationProperties.java
- DocumentDatabaseRegistrar.java
- ServiceRegistryController.java
- StringToApplicationTypeConverter.java
- ServiceInstancePropertyRequest.java
- ServiceInstanceRefreshRequest.java
- ServiceInstanceRegistrationRequest.java
- ServiceInstancePropertyResponse.java
- ServiceInstanceRegistrationResponse.java
- ServiceInstanceResponse.java
- ServiceResponse.java
- ServiceInstanceEntityTransformer.java
- LibraryConductorApplication.java
- application-local.properties
- application.properties
- banner.txt
- build.gradle
- DownloaderConfigurationProperties.java
- DownloaderParallelismConfiguration.java
- DownloaderStatisticsConfiguration.java
- SourceLocation.java
- StageConfiguration.java
- ParallelismInstancePropertyExtensionProvider.java
- ArchivingException.java
- NotEnoughSpaceException.java
- DocumentArchivingContext.java
- DocumentArchiver.java
- DocumentArchivingMessageFactory.java
- DocumentIdFactory.java
- DocumentLocationEvaluator.java
- DocumentLocationProcessingExecutor.java
- DocumentLocationProcessorTask.java
- DocumentLocationProcessorTaskFactory.java
- DocumentLocationProcessorWrapper.java
- AccumulatingBeaconDownloader.java
- BeaconDownloaderConfigurationProperties.java
- LoaderException.java
- BeaconDocumentArchiver.java
- BeaconDocumentLoader.java
- LoadocLoaderBeaconConfigurationProperties.java
- BeaconLoadocDocumentArchiver.java
- BeaconLoadocDocumentLoader.java
- OfflineBeaconDownloaderConfigurationProperties.java
- OfflineBeaconDownloader.java
- ReplyBeaconDownloader.java
- BeaconDocumentLocationFactory.java
- DocumentLocationCollector.java
- DownloaderFolderSourceConfigurationProperties.java
- DocumentFolderReader.java
- DownloadQueueListener.java
- QueueMessageHandler.java
- DocumentLocationCreationContextFactory.java
- LibraryDownloaderApplication.java
- application-local.properties
- application.properties
- banner.txt
- QueueSourceIntegrationTest.java
- DocumentArchiverTest.java
- DocumentArchivingMessageFactoryTest.java
- DocumentLocationCreationContextFactoryTest.java
- build.gradle
- GeneratorCommand.java
- LibraryGeneratorApplication.java
- application-local.properties
- application.properties
- banner.txt
- build.gradle
- IndexerCommand.java
- IndexerConfigurationProperties.java
- IndexerParallelismConfiguration.java
- ParallelismInstancePropertyExtensionProvider.java
- DocumentEntityIndexer.java
- LibraryIndexerApplication.java
- application-local.properties
- application.properties
- banner.txt
- build.gradle
- QueueInstancePropertyExtensionProvider.java
- ArtemisQueueInitializer.java
- LibraryQueueApplication.java
- application-local.properties
- application.properties
- banner.txt
- logback-spring.xml
- build.gradle
- StagingConfigurationProperties.java
- StageAccessException.java
- StageLocation.java
- StageLocationFactory.java
- StagingFreeSpaceInstancePropertyExtensionProvider.java
- StageDocumentController.java
- LibraryStagingApplication.java
- application.properties
- StageViewIntegrationTest.java
- StageLocationFactoryTest.java
- build.gradle
- MongoClientConfiguration.java
- StageConfiguration.java
- VaultConfigurationProperties.java
- VaultParallelismConfiguration.java
- VaultInstancePropertyExtensionProvider.java
- ArchivingMessageProcessor.java
- VaultQueueListener.java
- DocumentArchivingContextTransformer.java
- VaultNameInstanceRegistrationExtensionProvider.java
- VaultController.java
- InvalidRequestException.java
- RecompressDocumentRequest.java
- DocumentExistsResponse.java
- QueryDocumentResponse.java
- LibraryVaultApplication.java
- application-local.properties
- application.properties
- banner.txt
- VaultProcessingIntegrationTest.java
- VaultViewDefaultIntegrationTest.java
- VaultViewModificationDisabledIntegrationTest.java
- VaultControllerTest.java
- build.gradle
- DashboardController.java
- AdministratorApplicationInstance.java
- DashboardApplicationsResponse.java
- DashboardDocumentStatisticsResponse.java
- DownloaderApplicationInstance.java
- GeneratorApplicationInstance.java
- IndexerApplicationInstance.java
- QueueApplicationInstance.java
- StagingApplicationInstance.java
- VaultApplicationInstance.java
- ApplicationStatisticsResponseFactory.java
- DocumentStatisticsResponseFactory.java
- DocumentDebugController.java
- DocumentImageController.java
- DocumentQueryController.java
- DocumentSearchController.java
- DocumentStatisticsController.java
- DocumentDebugResponse.java
- DocumentSearchResponse.java
- DocumentStatisticsResponse.java
- SearchDocumentEntityResponse.java
- DocumentDebugResponseFactory.java
- SearchDocumentEntityResponseTransformer.java
- SearchDocumentEntityResponseTransformerTest.java
- InfoController.java
- InfoResponse.java
- DocumentLocationDebugController.java
- DocumentLocationDebugResponse.java
- DocumentLocationDebugResponseFactory.java
- UserController.java
- LoginRequest.java
- LoginResult.java
- InfoResponse.java
- LoginResponse.java
- LibraryWebApplication.java
- application-local.properties
- application.properties
- banner.txt
- build.gradle
- build.gradle
- app.e2e-spec.ts
- app.po.ts
- protractor.conf.js
- tsconfig.json
- administrator-application-instance.ts
- application-info-entity.ts
- downloader-application-instance.ts
- generator-application-instance.ts
- indexer-application-instance.ts
- queue-application-instance.ts
- vault-application-instance.ts
- vault-pplication-instance.ts
- application.service.ts
- debug-document.ts
- debug-location.ts
- debug.service.ts
- site-info.ts
- site-info.service.ts
- search-hit.ts
- search-result.ts
- search.service.ts
- statistics-service.ts
- login-response.ts
- user-info.ts
- user-service.ts
- app.component.html
- app.component.scss
- app.component.ts
- dashboard-applications.component.html
- dashboard-applications.component.scss
- dashboard-applications.component.ts
- dashboard-statistics.component.html
- dashboard-statistics.component.scss
- dashboard-statistics.component.ts
- debug-document.component.html
- debug-document.component.scss
- debug-document.component.ts
- debug-location.component.html
- debug-location.component.scss
- debug-location.component.ts
- home.component.html
- home.component.scss
- home.component.ts
- login.component.html
- login.component.scss
- login.component.ts
- search.component.html
- search.component.scss
- search.component.ts
- app-routing.module.ts
- app.module.ts
- bytes.pipe.ts
- background.png
- sphinx.ico
- sphinx.svg
- spinner.css
- environment.prod.ts
- environment.ts
- favicon.ico
- index.html
- main.ts
- polyfills.ts
- styles.scss
- test.ts
- .editorconfig
- .eslintrc.json
- .gitignore
- angular.json
- build.gradle
- karma.conf.js
- package-lock.json
- package.json
- README.md
- tsconfig.app.json
- tsconfig.json
- tsconfig.spec.json
- ApplicationType.java
- build.gradle
- BeaconClientConfiguration.java
- BeaconClientException.java
- BeaconDocumentLocation.java
- BeaconDocumentLocationResult.java
- DocumentLocationPartialRequest.java
- VisitDocumentLocationsRequest.java
- DocumentLocationResultPartialResponse.java
- VisitDocumentLocationsResponse.java
- BeaconClient.java
- build.gradle
- ChecksumConfigurationProperties.java
- ChecksumCalculationException.java
- ChecksumType.java
- ChecksumProvider.java
- Sha256ChecksumProvider.java
- Sha256ChecksumProviderTest.java
- checksum_test.txt
- build.gradle
- CompressionConfigurationProperties.java
- CompressionException.java
- DocumentCompression.java
- MissingCompressionServiceException.java
- CompressorServiceProvider.java
- BrotliCompressorService.java
- CompressorService.java
- GZIPCompressorService.java
- LZMACompressorService.java
- FileCompressionService.java
- CompressorServiceProviderTest.java
- build.gradle
- ConductorClientConfiguration.java
- ConductorClientConfigurationProperties.java
- ConductorClientException.java
- InstanceExtensionContext.java
- InstancePropertyExtensionProvider.java
- ServiceInstancePropertyRequest.java
- ServiceInstanceRefreshRequest.java
- ServiceInstanceRegistrationRequest.java
- ServiceInstancePropertyResponse.java
- ServiceInstanceRegistrationResponse.java
- ServiceInstanceResponse.java
- ServiceResponse.java
- ConductorClient.java
- NetworkAddressCalculationException.java
- InstanceRefreshSchedulerService.java
- NetworkAddressCalculator.java
- build.gradle
- ConductorClientTestUtility.java
- build.gradle
- ServiceInstanceEntity.java
- ServiceInstanceEntityProperty.java
- build.gradle
- ServiceInstanceProperty.java
- ServiceInstanceRefreshContext.java
- ServiceInstanceRegistrationContext.java
- ServiceInstanceContainer.java
- build.gradle
- DocumentLocationMongoConfiguration.java
- DocumentLocationDatabaseEntity.java
- DocumentLocationRepository.java
- build.gradle
- DocumentLocation.java
- DocumentLocationResultType.java
- DocumentLocation.java
- DocumentLocationCreationContext.java
- DocumentLocationEntityFactory.java
- DocumentLocationFactory.java
- DocumentLocationIdFactory.java
- Sha256DocumentLocationIdFactory.java
- DocumentLocationManipulator.java
- build.gradle
- DocumentParserConfiguration.java
- LoggerConfiguration.java
- ParsingException.java
- ParsingResult.java
- ExceptionParser.java
- DocumentDataParser.java
- build.gradle
- DocumentMongoConfiguration.java
- DocumentDatabaseEntity.java
- DocumentStatusAggregateEntity.java
- DocumentTypeAggregateEntity.java
- DocumentRepository.java
- build.gradle
- DocumentEntity.java
- DocumentStatus.java
- DuplicateDocumentException.java
- DocumentCreationContext.java
- DocumentEntityFactory.java
- DocumentEntityTransformer.java
- DocumentManipulator.java
- DocumentEntityFactoryTest.java
- DocumentTypeCalculatorTest.java
- build.gradle
- DocumentType.java
- DocumentTypeCalculator.java
- build.gradle
- MediaTypeCalculator.java
- build.gradle
- DocumentCollectionException.java
- DocumentCollector.java
- TrustAllTrustManager.java
- DownloaderClientConfiguration.java
- HttpClientConfigurationProperties.java
- FileDownloadManager.java
- DocumentCollectorTest.java
- build.gradle
- ZipFileManipulatorService.java
- FileManipulatorService.java
- ZipFileManipulatorServiceTest.java
- FileManipulatorServiceTest.java
- build.gradle
- IndexDatabaseConfiguration.java
- IndexingContext.java
- IndexDocumentFactory.java
- IndexerClient.java
- IndexRequestFactory.java
- DocumentLength.java
- DocumentSearchEntity.java
- DocumentSearchResult.java
- IndexerAccessException.java
- SearchContext.java
- SearchDatabaseEntity.java
- SearchField.java
- IndexerRequestFactory.java
- QueryBuilderFactory.java
- DocumentSearchEntityTransformer.java
- DocumentSearchClient.java
- IndexDocumentFactoryTest.java
- IndexerClientTest.java
- IndexRequestFactoryTest.java
- IndexerRequestFactoryTest.java
- DocumentSearchEntityTransformerTest.java
- DocumentSearchClientTest.java
- build.gradle
- DownloadResult.java
- DocumentLocationResultCalculator.java
- DocumentLocationResultCalculatorTest.java
- build.gradle
- LoadocMetadata.java
- build.gradle
- LoggingMeterRegistry.java
- MetricLogger.java
- build.gradle
- HexConversionException.java
- HexConverter.java
- build.gradle
- QueueClientConfiguration.java
- QueueServerConfiguration.java
- QueueServerConfigurationProperties.java
- DocumentArchivingMessageDeserializer.java
- DocumentLocationMessageDeserializer.java
- MessageDeserializer.java
- MessageDeserializerProvider.java
- QueueConsumer.java
- QueueConsumerProvider.java
- QueueProducer.java
- QueueProducerProvider.java
- DocumentArchivingMessageSerializer.java
- DocumentLocationMessageSerializer.java
- MessageSerializer.java
- MessageSerializerProvider.java
- ArtemisQueueManipulator.java
- DocumentArchivingMessageDeserializerTest.java
- DocumentArchivingMessageSerializerTest.java
- ArtemisQueueManipulatorTest.java
- build.gradle
- DocumentArchivingMessage.java
- DocumentLocationMessage.java
- Queue.java
- QueueException.java
- QueueManipulator.java
- build.gradle
- ImageRenderingException.java
- DocumentRendererService.java
- PageRendererService.java
- ThumbnailService.java
- build.gradle
- RepositoryConfiguration.java
- RepositoryMetadataContainer.java
- Error.java
- build.gradle
- FileDocumentSourceConfigurationProperties.java
- GeneratorStatisticsConfiguration.java
- FileEncodingType.java
- FileHandlingException.java
- FileDocumentLocationSource.java
- FileSourceFactory.java
- FileDocumentLocationSourceTest.java
- FileSourceFactoryTest.java
- build.gradle
- DocumentSourceConfigurationProperties.java
- DocumentSourceType.java
- DocumentLocationSource.java
- build.gradle
- StageAccessException.java
- StageLocation.java
- StageLocationFactory.java
- StageLocationFactoryTest.java
- build.gradle
- StagingClientConfiguration.java
- StagingException.java
- StagingClient.java
- build.gradle
- BlockingExecutor.java
- CallbackWrapperTask.java
- CounterIncrementingWrapperTask.java
- MDCWrapperTask.java
- ThreadManipulator.java
- build.gradle
- UrlEncoder.java
- UrlEncoderTest.java
- build.gradle
- UserMongoConfiguration.java
- UserAlreadyExistsInDatabaseException.java
- UserDatabaseEntity.java
- UserRepository.java
- build.gradle
- UserConfigurationProperties.java
- UserAlreadyExistsException.java
- UserEntity.java
- UserEntityFactory.java
- UserEntityTransformer.java
- build.gradle
- FileValidationConfigurationProperties.java
- DocumentFileValidator.java
- DocumentFileValidatorTest.java
- build.gradle
- VaultClientConfiguration.java
- VaultAccessException.java
- VaultLocation.java
- RecompressDocumentRequest.java
- DocumentExistsResponse.java
- QueryDocumentResponse.java
- VaultClientService.java
- VaultLocationContainer.java
- VaultLocationFetcher.java
- VaultClientServiceTest.java
- build.gradle
- StorageAccessException.java
- ArchivingService.java
- DocumentCreationContextFactory.java
- DocumentArchivingContext.java
- SqliteConfigurationProperties.java
- SqliteConnectionManager.java
- RecompressorService.java
- VaultDocumentManager.java
- ArchivingServiceTest.java
- DocumentCreationContextFactoryTest.java
- SqliteConnectionManagerTest.java
- build.gradle
- build.gradle
- .gitignore
- build.gradle
- gradle.properties
- gradlew
- gradlew.bat
- LICENSE
- lombok.config
- README.md
- settings.gradle
# Installation Guide
1. Get the code
git clone https://github.com/bottomless-archive-project/library-of-alexandria
Downloads the entire project code from GitHub to your computer.
cd library-of-alexandria
Moves into the project folder you just downloaded.
2. Gradle (Java/Kotlin)
Medium RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- JDK (Java) Required to build and run Java/Kotlin projects.
- Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew build
Builds the project using Gradle.
A BUILD SUCCESSFUL message means it worked. The output is created under build/.
3. Node.js
EasyPrerequisites
cd loa-frontend
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)
