Finalize README

This commit is contained in:
Christopher C. Wells 2021-04-24 13:50:14 -07:00
parent 72f98ebd7f
commit d8c22fd816
1 changed files with 22 additions and 8 deletions

View File

@ -9,18 +9,20 @@ This is a template repository for running [kcal](https://github.com/kcal-app/kca
with Docker Compose. Visit the main [kcal](https://github.com/kcal-app/kcal) repository
for more information about the application.
## 1. Clone
## Getting Started
### 1. Clone
Clone this repo.
git clone https://github.com/kcal-app/kcal-docker.git
## 2. Create `.env` file.
### 2. Create `.env` file.
cd kcal-docker
cp .env.example .env
## 3. Generate and add an `APP_KEY` to the `.env` file.
### 3. Generate and add an `APP_KEY` to the `.env` file.
docker-compose run app php artisan key:generate --show
@ -29,21 +31,33 @@ This command will output a suitable key. Copy the key value and add it to the
changes to the `.env` file (e.g. set the `APP_TIMEZONE` and `APP_URL` values as
desired).
## 4. Launch! :rocket:
### 4. Launch! :rocket:
docker-compose up -d
## 5. Set up application.
### 5. Set up application.
docker-compose exec app php artisan optimize
docker-compose exec app php artisan migrate
docker-compose exec app php artisan elastic:migrate
## 6. Create initial user.
### 6. Create initial user.
docker-compose exec app php artisan user:add --admin
## 7. Log in!
### 7. Log in!
Navigate to [http://127.0.0.1/](http://127.0.0.1/) (or the `APP_URL`) and log in
with the user created in the previous step.
with the user created in the previous step.
## Configuration
Kcal can be configured in various ways using environment variables from the `.env`
file. When changes are made to the environment variables restart the containers
and re-run the "optimize" command:
docker-compose restart
docker-compose exec app php artisan optimize
See the [kcal configuration documentation](https://github.com/kcal-app/kcal#configuration)
for more information about what can be configured and how.