You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# TODO: we are currently just using the latest containers without building them beforehand. Maybe add deployment as step of the pipeline on commits on the main branch
42
-
- name: Replace OPEN API key
37
+
- name: Set up kubeconfig
43
38
run: |
44
-
cp ./helm/values.yaml.template ./helm/values.yaml
45
-
sed -i 's/<YOUR_OPEN_API_KEY>/test/g' ./helm/values.yaml
Copy file name to clipboardExpand all lines: README.md
+36-2Lines changed: 36 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,33 @@
1
1
# Mentor Pulse
2
2
3
+
TODO: short introduction what mentor pulse is
4
+
5
+
## Local Development Setup
6
+
7
+
TODO: documentation to add for project setup (e.g. how to start with docker)
8
+
9
+
```
10
+
docker compose up --build
11
+
```
12
+
13
+
```
14
+
docker compose down -v
15
+
```
16
+
17
+
### Loading Mock Data
18
+
19
+
TODO: add link to mock data scripts
20
+
21
+
## Deployment
22
+
23
+
TODO: add documentation about deployments
24
+
25
+
### Kubernetes
26
+
27
+
TODO: add link to kubernetes
28
+
29
+
### EC2
30
+
3
31
## Endpoint Documentation
4
32
5
33
The endpoints are documented using OpenAPI or Swagger schemas:
@@ -12,6 +40,12 @@ The endpoints are documented using OpenAPI or Swagger schemas:
12
40
13
41
Alternatively, you can also find the endpoints in the controllers of the services (e.g. [MentorProfileController](server/mentorshipservice/src/main/java/com/mentorpulse/mentorshipservice/controller/MentorProfileController.java), [GenAI](genai/controllers/api_controller.py)). Additionally, some are also documented in `.bru` files (see [mentor-pulse-bruno](/docs/mentor-pulse-bruno/)).
14
42
15
-
## Setup
43
+
## Generating Open API Schemas for Microservices
16
44
17
-
TODO: documentation to add for project setup (e.g. how to start with docker)
45
+
This is how you can generate schemas for the Java microservices. For [genai](/genai/README.md) the setup is different.
46
+
47
+
1. Start database via `docker compose up --build postgres-db`.
48
+
2. Start service via `docker compose up --build <service-name>` for which you want to generate the schema.
49
+
3. Navigate to service that you want to generate the schema for. Execute `./gradlew generateOpenApiDocs` in root
50
+
directory of service. Alternatively, open `http://<endpoint>/v3/api-docs.yaml` in a browser and move the schema to
0 commit comments