[DEV] update readme

This commit is contained in:
Edouard DUPIN 2024-04-15 00:57:00 +02:00
parent d5f335e1e7
commit 9e0a834b48

View File

@ -3,8 +3,8 @@ Karideo
**K**angaroo **A**nd **R**abbit (m)usic is a simple framework to propose music streaming for personal network
Run and install:
================
Run in local:
=============
so simple...
@ -20,23 +20,56 @@ cd ../front
docker-compose up -d
```
build the local image:
docker pull archlinux:base-devel
docker pull bellsoft/liberica-openjdk-alpine:latest
docker build -t gitea.atria-soft.org/kangaroo-and-rabbit/karusic:latest .
docker login gitea.atria-soft.org
docker push gitea.atria-soft.org/kangaroo-and-rabbit/karusic:latest
convert in an angular application:
https://betterprogramming.pub/how-to-convert-your-angular-application-to-a-native-mobile-app-android-and-ios-c212b38976df
Link with the external sub-library (front)
------------------------------------------
Link:
```bash
cd front
pnpm run link_kar_cw
```
un-link:
```bash
cd front
pnpm run unlink_kar_cw
```
pnpm link ../../kar-cw/dist/kar-cw/
Manual set in production:
=========================
Connect on the registry
------------------------
To log-in and log-out from the registry:
```bash
export REGISTRY_ADDRESS=gitea.atria-soft.org
docker login -u <<YOUR_USER_NAME>> ${REGISTRY_ADDRESS}
docker logout ${REGISTRY_ADDRESS}
```
pull the root image of dockers
------------------------------
```bash
docker pull archlinux:base-devel
docker pull bellsoft/liberica-openjdk-alpine:latest
```
Create the version
------------------
Execute in the local folder: (use ```dev``` for development and ```latest``` for production release)
```bash
export TAG_DOCKER=latest
export REGISTRY_ADDRESS=gitea.atria-soft.org
docker build -t ${REGISTRY_ADDRESS}/kangaroo-and-rabbit/karusic:${TAG_DOCKER} .
docker push ${REGISTRY_ADDRESS}/kangaroo-and-rabbit/karusic:${TAG_DOCKER}
```