readme

apps/README.md

@@ -0,0 +1,19 @@
+# IntelliQ Apps
+
+This repository contains multiple applications that are part of the IntelliQ project. Each application serves a different purpose and is organized into separate directories.
+
+## Structure
+
+- **web/**: Contains the [IntelliQ landing page](https://www.intelliq.dev/).
+- **presentation/**: Holds the [presentation website](https://presentation.intelliq.dev/) required for a diploma thesis.
+- **docs/**: Documentation files for the project, including the [API documentation](https://docs.intelliq.dev/api-reference/introduction).
+- **dashboard/**: The [dashboard application](https://app.intelliq.dev/) where players can create quizzes.
+- **api/**: Backend API services used throughout the app.
+
+## Getting Started
+
+To get started with any of the applications, navigate to the respective directory and follow the setup instructions provided in their README files.
+
+## License
+
+This project is licensed under the AGPL-3.0 License - see the [LICENSE](../LICENSE) file for details.

apps/api/README.md

@@ -1,8 +1,38 @@
-```
-npm install
-npm run dev
-```
-
-```
-npm run deploy
-```
+# IntelliQ API
+
+This directory contains the backend API services for the IntelliQ project. The API is designed to handle various functionalities such as quiz generation, user management, and more.
+
+## API Documentation
+
+For detailed API documentation, please refer to the [IntelliQ API Reference](https://docs.intelliq.dev/api-reference/introduction).
+
+## Setup
+
+To set up the API locally, follow these steps:
+
+1. Install the dependencies:
+
+   ```bash
+   npm install
+   ```
+
+2. Start the development server:
+
+   ```bash
+   npm run dev
+   ```
+
+3. To deploy the API, use:
+   ```bash
+   npm run deploy
+   ```
+
+## Configuration
+
+- **wrangler.toml**: Configuration for Cloudflare Workers.
+- **tsconfig.json**: TypeScript configuration file.
+- **drizzle/**: Contains database migration and schema files.
+
+## License
+
+This project is licensed under the AGPL-3.0 License - see the [LICENSE](../LICENSE) file for details.