Merge pull request #52 from sdsc-ordes/feat/readme

chore: update example env

Author: sabinem

.env.example

@@ -3,7 +3,7 @@ PUBLIC_QLEVER_UI_URL=https://catplus.swisscustodian.ch/default
 PUBLIC_CATPLUS_ONTOLOGY_URL=https://sdsc-ordes.github.io/catplus-ontology/
 PUBLIC_SWISSCAT_URL=https://www.epfl.ch/research/facilities/swisscat/
 PUBLIC_SDSC_URL=https://www.datascience.ch/
-PUBLIC_CHEMBORD_GITHUB_URL=https://github.com/sdsc-ordes/catplus-chembord.git
+PUBLIC_CHEMBORD_GITHUB_URL=https://github.com/sdsc-ordes/catplus-chemboard.git
 
 # Qlever Access
 QLEVER_API_URL=https://catplus.swisscustodian.ch/sparql/default/
@@ -16,8 +16,5 @@ AWS_ACCESS_KEY_ID=
 AWS_SECRET_ACCESS_KEY=
 
 # Sveltekit Configuration
-BASE_PATH=/chembord
 ORIGIN=http://localhost:3000
-PROTOCOL_HEADER=x-forwarded-proto
-ADDRESS_HEADER=True-Client-IP
-HOST_HEADER=x-forwarded-host
+PUBLIC_RESULTS_PER_PAGE="3"

README.md

@@ -1,7 +1,12 @@
 # Catplus Chembord
 
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+## Technology
 
+The catplus chembord uses the following technologies:
+
+- [Sveltekit](https://svelte.dev/) as Frontend Framework
+- [pnpm](https://pnpm.io/) for node setup
+- [Skeleton UI](https://www.skeleton.dev/) for the styles
 
 ## Quickstart
 
@@ -11,16 +16,9 @@ First, define your .env file by copying the example:
 
 ```bash
 cp .env.example .env
-
-# Edit .env
 ```
 
-> NOTE: changing the BASE_PATH requires rebuilding the image
-
-Then let docker run the container with variables loaded from the env file:
-```bash
-docker run -p 3000:3000 --env-file .env ghcr.io/sdsc-ordes/catplus-chembord:latest
-```
+Edit .env
 
 ## Development Environment
 
@@ -41,9 +39,11 @@ Then use just to install, build and run the project:
 ```bash
 just install
 just build
-just run # this also installs and builds the project
+just local
 ```
 
+`just local` serves the chembord at `http://localhost:5173/chembord`
+
 ### Docker
 
 The docker image can be built using `just image` subcommands:

src/routes/search/+page.server.ts

@@ -32,10 +32,10 @@ export const load: PageServerLoad = async ({ url }) => {
         ) as Record<FilterCategory, string[]>;
 
         const currentPage = Math.max(1, parseInt(url.searchParams.get('page') as string, 10) || 1);
-        logger.info(currentPage, "Current Page from URL Search Params");
+        logger.debug(currentPage, "Current Page from URL Search Params");
         const pageSize = publicConfig.PUBLIC_RESULTS_PER_PAGE;
         const offset = (currentPage - 1) * pageSize;
-        logger.info({ pageSize, offset }, "Page Size and Offset for Pagination");
+        logger.debug({ pageSize, offset }, "Page Size and Offset for Pagination");
 
         //------------------------ Create and Execute Queries ------------------------
         // 1. Create the sparql query strings
@@ -55,7 +55,7 @@ export const load: PageServerLoad = async ({ url }) => {
             getSparqlQueryResult(generatedQueries.countQuery),
             getSparqlQueryResult(generatedQueries.resultsQuery)
         ]);
-		logger.info({ countResult }, "Count Result:");
+		logger.debug({ countResult }, "Count Result:");
 		logger.debug({ queryResult }, "Query Result:");
 
         // 3. Process the results to define your variables