Skip to content

Commit

Permalink
Customize repository
Browse files Browse the repository at this point in the history
pglez82 committed Jan 20, 2025
1 parent 6e056d6 commit 1719008
Showing 11 changed files with 42 additions and 42 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI for wichat_0
name: CI for wichat_es5b

on:
release:
@@ -56,7 +56,7 @@ jobs:
API_URI: http://${{ secrets.DEPLOY_HOST }}:8000
LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
with:
name: arquisoft/wichat_0/webapp
name: arquisoft/wichat_es5b/webapp
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
registry: ghcr.io
@@ -76,7 +76,7 @@ jobs:
- name: Publish to Registry
uses: elgohr/Publish-Docker-Github-Action@v5
with:
name: arquisoft/wichat_0/authservice
name: arquisoft/wichat_es5b/authservice
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
registry: ghcr.io
@@ -95,7 +95,7 @@ jobs:
- name: Publish to Registry
uses: elgohr/Publish-Docker-Github-Action@v5
with:
name: arquisoft/wichat_0/userservice
name: arquisoft/wichat_es5b/userservice
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
registry: ghcr.io
@@ -113,7 +113,7 @@ jobs:
- name: Publish to Registry
uses: elgohr/Publish-Docker-Github-Action@v5
with:
name: arquisoft/wichat_0/llmservice
name: arquisoft/wichat_es5b/llmservice
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
registry: ghcr.io
@@ -135,7 +135,7 @@ jobs:
- name: Publish to Registry
uses: elgohr/Publish-Docker-Github-Action@v5
with:
name: arquisoft/wichat_0/gatewayservice
name: arquisoft/wichat_es5b/gatewayservice
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
registry: ghcr.io
@@ -152,6 +152,6 @@ jobs:
# user: ${{ secrets.DEPLOY_USER }}
# key: ${{ secrets.DEPLOY_KEY }}
# command: |
# wget https://raw.githubusercontent.com/arquisoft/wichat_0/master/docker-compose.yml -O docker-compose.yml
# wget https://raw.githubusercontent.com/arquisoft/wichat_es5b/master/docker-compose.yml -O docker-compose.yml
# docker compose --profile prod down
# docker compose --profile prod up -d --pull always
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# wichat_0
# wichat_es5b

[![Actions Status](https://github.com/arquisoft/wichat_0/workflows/CI%20for%20wichat_0/badge.svg)](https://github.com/arquisoft/wichat_0/actions)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_0&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_0)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_0&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_0)
[![Actions Status](https://github.com/arquisoft/wichat_es5b/workflows/CI%20for%20wichat_es5b/badge.svg)](https://github.com/arquisoft/wichat_es5b/actions)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_es5b&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_es5b)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_es5b&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_es5b)

<p float="left">
<img src="https://blog.wildix.com/wp-content/uploads/2020/06/react-logo.jpg" height="100">
@@ -23,7 +23,7 @@ Both the user and auth service share a Mongo database that is accessed with mong

First, clone the project:

```git clone git@github.com:arquisoft/wichat_0.git```
```git clone git@github.com:arquisoft/wichat_es5b.git```

### LLM API key configuration

@@ -106,7 +106,7 @@ deploy:
user: ${{ secrets.DEPLOY_USER }}
key: ${{ secrets.DEPLOY_KEY }}
command: |
wget https://raw.githubusercontent.com/arquisoft/wichat_0/master/docker-compose.yml -O docker-compose.yml
wget https://raw.githubusercontent.com/arquisoft/wichat_es5b/master/docker-compose.yml -O docker-compose.yml
docker compose --profile prod down
docker compose --profile prod up -d --pull always
```
26 changes: 13 additions & 13 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
services:
mongodb:
container_name: mongodb-wichat_0
container_name: mongodb-wichat_es5b
image: mongo
profiles: ["dev", "prod"]
volumes:
@@ -11,8 +11,8 @@ services:
- mynetwork

authservice:
container_name: authservice-wichat_0
image: ghcr.io/arquisoft/wichat_0/authservice:latest
container_name: authservice-wichat_es5b
image: ghcr.io/arquisoft/wichat_es5b/authservice:latest
profiles: ["dev", "prod"]
build: ./users/authservice
depends_on:
@@ -25,8 +25,8 @@ services:
MONGODB_URI: mongodb://mongodb:27017/userdb

userservice:
container_name: userservice-wichat_0
image: ghcr.io/arquisoft/wichat_0/userservice:latest
container_name: userservice-wichat_es5b
image: ghcr.io/arquisoft/wichat_es5b/userservice:latest
profiles: ["dev", "prod"]
build: ./users/userservice
depends_on:
@@ -39,8 +39,8 @@ services:
MONGODB_URI: mongodb://mongodb:27017/userdb

llmservice:
container_name: llmservice-wichat_0
image: ghcr.io/arquisoft/wichat_0/llmservice:latest
container_name: llmservice-wichat_es5b
image: ghcr.io/arquisoft/wichat_es5b/llmservice:latest
profiles: ["dev", "prod"]
build: ./llmservice
ports:
@@ -49,8 +49,8 @@ services:
- mynetwork

gatewayservice:
container_name: gatewayservice-wichat_0
image: ghcr.io/arquisoft/wichat_0/gatewayservice:latest
container_name: gatewayservice-wichat_es5b
image: ghcr.io/arquisoft/wichat_es5b/gatewayservice:latest
profiles: ["dev", "prod"]
build: ./gatewayservice
depends_on:
@@ -68,8 +68,8 @@ services:
LLM_SERVICE_URL: http://llmservice:8003

webapp:
container_name: webapp-wichat_0
image: ghcr.io/arquisoft/wichat_0/webapp:latest
container_name: webapp-wichat_es5b
image: ghcr.io/arquisoft/wichat_es5b/webapp:latest
profiles: ["dev", "prod"]
build:
context: ./webapp
@@ -82,7 +82,7 @@ services:

prometheus:
image: prom/prometheus
container_name: prometheus-wichat_0
container_name: prometheus-wichat_es5b
profiles: ["dev"]
networks:
- mynetwork
@@ -96,7 +96,7 @@ services:

grafana:
image: grafana/grafana
container_name: grafana-wichat_0
container_name: grafana-wichat_es5b
profiles: ["dev"]
networks:
- mynetwork
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## The documentation
In this project, the documentation is compiled locally and deployed to GitHub pages.
The deployment url is: [https://arquisoft.github.io/wichat_0/](https://arquisoft.github.io/wichat_0/).
The deployment url is: [https://arquisoft.github.io/wichat_es5b/](https://arquisoft.github.io/wichat_es5b/).

### Documentation build
For the documentation, we are going to use [AsciiDoc](https://asciidoc.org/) and [PlantUML](https://plantuml.com) and follow the [Arc42](https://github.com/arc42/arc42-template) template. If you want to be able to generate the doc locally you need to install Ruby, Java and some dependencies to translate the AsciiDoc code into html. If you are in Linux you can install Ruby and Java simply by executing:
@@ -30,6 +30,6 @@ npm run build
The documentation will be generated under the `docs/build` directory.

### Documentation deployment
If we want to deploy it to GitHub pages, so it is accessible via [https://arquisoft.github.io/wichat_0/](https://arquisoft.github.io/wichat_0/), we need to execute `npm run deploy`.
If we want to deploy it to GitHub pages, so it is accessible via [https://arquisoft.github.io/wichat_es5b/](https://arquisoft.github.io/wichat_es5b/), we need to execute `npm run deploy`.

If you check the `package.json` in this directory you can see how deploying is as easy as executing `gh-pages -d build`, which can be directly executed using `npm run deploy` in the docs directory. The `gh-pages` package is in charge of pushing the documentation generated directory (basically some htmls) to a special github branch called gh-pages. Everything pushed to this branch is accessible on the repository page. Note that we only want to push there the documentation. Also is important that the documentation build is not pushed to the other branches of the project.
2 changes: 1 addition & 1 deletion docs/index.adoc
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
// configure EN settings for asciidoc
include::src/config.adoc[]

= image:arc42-logo.png[arc42] wichat_0
= image:arc42-logo.png[arc42] wichat_es5b
:revnumber: 8.2 EN
:revdate: January 2023
:revremark: (based upon AsciiDoc version)
6 changes: 3 additions & 3 deletions gatewayservice/package.json
Original file line number Diff line number Diff line change
@@ -9,14 +9,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/arquisoft/wichat_0.git"
"url": "git+https://github.com/arquisoft/wichat_es5b.git"
},
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/arquisoft/wichat_0/issues"
"url": "https://github.com/arquisoft/wichat_es5b/issues"
},
"homepage": "https://github.com/arquisoft/wichat_0#readme",
"homepage": "https://github.com/arquisoft/wichat_es5b#readme",
"dependencies": {
"axios": "^1.7.9",
"cors": "^2.8.5",
2 changes: 1 addition & 1 deletion llmservice/package.json
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@
"author": "",
"license": "ISC",
"description": "",
"homepage": "https://github.com/arquisoft/wichat_0#readme",
"homepage": "https://github.com/arquisoft/wichat_es5b#readme",
"dependencies": {
"axios": "^1.7.9",
"express": "^4.21.2"
4 changes: 2 additions & 2 deletions sonar-project.properties
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
sonar.organization=arquisoft
sonar.host.url=https://sonarcloud.io
sonar.projectKey=Arquisoft_wichat_0
sonar.projectKey=Arquisoft_wichat_es5b

sonar.language=js
sonar.projectName=wichat_0
sonar.projectName=wichat_es5b

sonar.coverage.exclusions=**/*.test.js
sonar.sources=webapp/src/components,users/authservice,users/userservice,llmservice,gatewayservice
6 changes: 3 additions & 3 deletions users/authservice/package.json
Original file line number Diff line number Diff line change
@@ -9,14 +9,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/arquisoft/wichat_0.git"
"url": "git+https://github.com/arquisoft/wichat_es5b.git"
},
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/arquisoft/wichat_0/issues"
"url": "https://github.com/arquisoft/wichat_es5b/issues"
},
"homepage": "https://github.com/arquisoft/wichat_0#readme",
"homepage": "https://github.com/arquisoft/wichat_es5b#readme",
"dependencies": {
"bcrypt": "^5.1.1",
"body-parser": "^1.20.3",
6 changes: 3 additions & 3 deletions users/userservice/package.json
Original file line number Diff line number Diff line change
@@ -9,14 +9,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/arquisoft/wichat_0.git"
"url": "git+https://github.com/arquisoft/wichat_es5b.git"
},
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/arquisoft/wichat_0/issues"
"url": "https://github.com/arquisoft/wichat_es5b/issues"
},
"homepage": "https://github.com/arquisoft/wichat_0#readme",
"homepage": "https://github.com/arquisoft/wichat_es5b#readme",
"dependencies": {
"bcrypt": "^5.1.1",
"express": "^4.21.2",
2 changes: 1 addition & 1 deletion webapp/public/index.html
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>wichat_0</title>
<title>wichat_es5b</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>

0 comments on commit 1719008

Please sign in to comment.