Merge pull request #1 from oellers/logo

add logo

.gitignore

@@ -19,3 +19,6 @@ Thumbs.db
 # Vite
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
+
+# IDE
+.vscode

README.md

@@ -1,38 +1,91 @@
-# sv
+# EduVocs - An interactive vocabulary database
 
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+EduVocs is an interactive database designed to address the challenges of interoperability and standardization in the education sector. Developed as part of the BIRD (Bildungsraum Digital) research and development project, EduVocs simplifies the search, reuse, and harmonization of controlled vocabularies, fostering connectivity across national and international educational services.
 
-## Creating a project
+## Introduction
 
-If you're seeing this, you've probably already done this step. Congrats!
+In an interconnected educational landscape, the absence of standardized vocabularies often results in fragmented solutions that hinder data exchange and collaboration.
 
-```bash
-# create a new project in the current directory
-npx sv create
+EduVocs tackles this challenge by:
 
-# create a new project in my-app
-npx sv create my-app
-```
+- Collecting, structuring, and making accessible existing controlled vocabularies.
+- Facilitating communication among diverse stakeholders.
+- Promoting harmonization within the educational sector.
+- Reducing redundant efforts in vocabulary development.
+- Enhancing interoperability and compatibility with global developments.
+- Simplifying data exchange among various services.
+
+EduVocs is a resource for exploring vocabularies from national and international educational projects, offering visibility and reusability for controlled vocabularies.
+
+## Development
+
+Every interested party is encouraged to contribute to this project.
+
+### Frameworks
+
+- [Svelte](https://svelte.dev/)
 
-## Developing
+### Local server
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+Run the local development server:
 
 ```bash
 npm run dev
+```
+
+To automatically open the app in a browser tab:
 
-# or start the server and open the app in a new browser tab
+```bash
 npm run dev -- --open
 ```
 
-## Building
+**Note:** This runs the development server powered by Vite (`vite dev`) to support code changes on-the-fly.
 
-To create a production version of your app:
+### Build for deployment
+
+Bundle a production-ready build to `./dist`, optimizing the project for deployment based on Vite (`vite build`):
 
 ```bash
 npm run build
 ```
 
-You can preview the production build with `npm run preview`.
+### Preview for deployment
+
+Preview the production-ready build from `./dist` locally using Vite (`vite preview`):
+
+```bash
+npm run preview
+```
+
+### Deployment
+
+Deploy the app, e.g. with Vercel by using the `@sveltejs/adapter-vercel` (see [Documentation](https://svelte.dev/docs/kit/adapter-vercel)).
+
+## Scripts
+
+- **`dev`**: Starts the development server (`vite dev`).
+- **`build`**: Builds the project for production (`vite build`).
+- **`preview`**: Previews the production build locally (`vite preview`).
+- **`check`**: Synchronizes SvelteKit and runs TypeScript checks using a custom `tsconfig` file.
+- **`check:watch`**: Runs `check` in watch mode to dynamically validate changes.
+- **`format`**: Formats the project files using Prettier.
+- **`lint`**: Checks the project files for style and syntax issues using Prettier and ESLint.
+
+## Contributions
+
+We welcome contributions to the EduVocs project!
+
+Examples of participation:
+
+1. Submitting new vocabularies or suggestions for improvement.
+2. Reporting issues and proposing fixes.
+3. Enhancing the documentation or code.
+
+Feel free to open a pull request or create an issue on GitHub.
+
+Together, we can make EduVocs a cornerstone of interoperability in the educational sector!
+
+## Authors
 
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+- [Steffen Rörtgen](https://github.com/sroertgen/)
+- [Manuel Oellers](https://github.com/oellers/)

src/lib/components/Sidebar.svelte

@@ -1,5 +1,6 @@
 <script>
 	import MenuIcon from '$lib/icons/MenuIcon.svelte';
+	import Logo from '$lib/icons/Logo.svelte';
 	let open = false;
 </script>
 
@@ -17,7 +18,7 @@
 	class={`fixed inset-y-0 left-0 z-50 w-64 transform bg-white shadow-md transition-transform lg:static lg:inset-0 lg:translate-x-0 ${open ? 'translate-x-0' : '-translate-x-full'}`}
 >
 	<nav class="flex flex-col gap-4 p-4">
-		<a href="/" class="btn btn-ghost">EduVocs</a>
+		<a href="/"><Logo /></a>
 		<a href="/search" class="btn btn-ghost">Suche</a>
 		<a href="/content/contact" class="btn btn-ghost">Kontakt</a>
 	</nav>