From 03ada4411ca47ab609d34b0a0d6775dbbe65acc6 Mon Sep 17 00:00:00 2001 From: KjellBerlin Date: Sat, 5 Oct 2024 14:55:38 +0200 Subject: [PATCH] Update readme file --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index df05e34..38cff08 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -# Core application +# The Carbonara App + +The Carbonara app is an open-source project designed to demonstrate how various components can be combined to create a fully functional end-to-end solution, with both frontend and backend. This React Native app is inspired by a sample from Creative Tim. + +Important Notice: +This project is provided without a license. As such, the use of this code—whether for commercial or non-commercial purposes—is strictly prohibited without explicit permission from the project owner. The code is shared solely for educational purposes and as a source of inspiration. + +If you wish to use the code, please contact me to request permission. + +Some articles about the carbonara app can be found on my medium account https://medium.com/@kjell.lilliestolze. + ## Build and Push ### Build docker image Do not forget to use right tag @@ -9,13 +19,16 @@ docker build -t netflixnetflix/carbonara-core:0.6 . ### Push docker image do google cloud artifact registry Update tag ```bash -docker tag netflixnetflix/carbonara-core:0.6 europe-west3-docker.pkg.dev/carbonara-395019/carbonara-repo/carbonara-core:0.6 +docker tag netflixnetflix/carbonara-core:0.6 {artifact-registry-url}:0.6 ``` ```bash -docker push europe-west3-docker.pkg.dev/carbonara-395019/carbonara-repo/carbonara-core:0.6 +docker push {artifact-registry-url}:0.6 ``` ## Running locally + +To run it locally, you also need to run a local MongoDB instance for example in a docker container. + ### Running on docker locally - Profile docker-dev is being used, to connect to db running in docker - Use the right tag @@ -30,4 +43,4 @@ docker run -d -it -p 8080:8080 --name carbonara-core -e "SPRING_PROFILES_ACTIVE= docker compose up ``` - Set active profile to dev -- Start application via gui \ No newline at end of file +- Start application via gui