adding running locally documentation #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FredMark
reviewed
Dec 2, 2023
| @@ -0,0 +1,20 @@ | |||
| # Docker | |||
| We are running the application within containers. Using Docker (or podman). | |||
| Information about using Docker is widly spread on the internet. We only have some basic information mentioned here. | |||
FredMark
reviewed
Dec 2, 2023
| 1. To start: `docker-compose up -d` (or `docker-compose start` if just stopped) | ||
| 2. To enter the container (initialize): `docker exec -it olm-web /bin/bash` | ||
| 3. To load dummy data (initialize): `php artisan migrate:fresh --seed` | ||
| 4. Log out or the container using (after initialisation) `ctrl-d` or `exit` |
There was a problem hiding this comment.
initialisation --> initialization
FredMark
reviewed
Dec 2, 2023
| With those two pre-requisites you can start the containers locally. | ||
| Be aware, for some features you need `keys`, which are not *free to use* from the community. If needed, reach out to the core team for help. | ||
|
|
||
| After first startup, we have to do some manual actions. In the future we gonna try to get these steps within setup-containers. |
FredMark
reviewed
Dec 2, 2023
|
|
||
| If you want to run the environment locally, that's possible! | ||
| You have to download the main repo(s) where a `docker-compose` file is in. | ||
| Also you have to have *Docker* (or podman) installed on you machine. |
FredMark
reviewed
Dec 2, 2023
|
|
||
| NB: If you have initialized the database, you can skip the *initialize* steps. Step one is mandatory. | ||
|
|
||
| You should see the basic site now. Several function will work, several will not work. |
FredMark
approved these changes
Dec 2, 2023
There was a problem hiding this comment.
I reviewed them,
Hard to tell if everything is okay,
I guess i will find out when i really start to use the manual to set it up myself (not tonight though, too late already),
I added some 'typos'-review, which are not that important, so i will chose 'approve' (submit feedback and approve)
GeniJaho
approved these changes
Dec 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Gents,
I added a new section to the documentation.for the option to work with containers localy.