Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
KjellBerlin committed Oct 5, 2024
1 parent 7d6f237 commit 03ada44
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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
- Start application via gui

0 comments on commit 03ada44

Please sign in to comment.