kcal – the personal food nutrition journal

Deployment

Heroku

After initial deployment the APP_KEY environment variable must be set as Heroku's deploy button does not support the necessary format. This can be set one of two ways:

From App Settings

1. Navigate to the deployed app.

2. Click the "More" menu and select "Run console".

3. Enter the following command and click "Run".

    php artisan --no-ansi key:generate --show
   

4. Copy the output from the command (it should start with base64:).

5. Close the console.

6. Navigate to the "Settings" tab, "Config Vars" section.

7. Click "Reveal Config Vars".

8. Enter a new config var with values:

   • KEY: APP_KEY
   • VALUE: Paste console out copied from Step 4

9. Click "Add"

The application will restart after setting the config var and login will work.

Using Heroku CLI

With the Heroku CLI utility installed and connected to the app, execute:

heroku config:set APP_KEY=$(php artisan --no-ansi key:generate --show)

Redis Add-on

The Heroku Redis add-on can be added to the app and will work without any configuration changes. It is left out of the default build only because it takes a very long time to provision.

Search 🔍

The "ingredient" (food or recipe) search for journal entries and recipe ingredients supports three different backends using the SCOUT_DRIVER environment variable. In all cases, always ensure that the SCOUT_DRIVER environment variable is only set once in kcal's .env file.

Currently, the food and recipe list searches do not take advantage of these search drivers. Support for those searches will be added if the Laravel JSON:API adds support for Scout (see: laravel-json-api/laravel#32).

Algolia (algolia)

1. Create and/or log in to an Algolia account.

2. Create an application for kcal.

3. Navigate to the application's "API Keys" section.

4. Using the Application ID and Admin API Key values, update kcal's .env file:

    SCOUT_DRIVER=algolia
    ALGOLIA_APP_ID=<APPLICATION_ID>
    ALGOLIA_SECRET=<ADMIN_API_KEY>
   

ElasticSearch (elastic)

1. Determine the host and port for your ElasticSearch service.

2. Update kcal's .env file.

    SCOUT_DRIVER=elastic
    ELASTIC_HOST=<HOST:PORT>
    ELASTIC_PORT=<PORT>
   

   Note: The ELASTIC_PORT variable is a convenience option specifically for Docker Compose configurations and is not strictly required.

3. Run Elastic's migrations.

    php artisan elastic:migrate
   

Fallback (null)

The fallback driver is a simple WHERE ... LIKE clause search on a couple of key fields. Results will not be ordered by relevance, and some fields will not be searched (e.g. the tags fields). Using one of the other options is highly recommended.

Set SCOUT_DRIVER=null in kcal's .env file to use the fallback driver.

Development

Laravel Sail

Prerequisites

• Composer
• Docker
• Docker compose

1. Clone the repository.

    git clone https://github.com/kcal-app/kcal.git
   

2. Move in to the cloned folder.

    cd kcal
   

3. Install development dependencies.

    composer install
   

4. Create a local .env file.

    cp .env.local.example .env
   

   Note: the default APP_URL setting is http://127.0.0.1. If you have dnsmasq or something similar configured for the test domain you can change this to http://kcal.test.

5. Generate an app key.

    touch .env
    php artisan key:generate
   

6. Run it! ⛵

    vendor/bin/sail up -d
   

7. (On first run) Run migrations.

    vendor/bin/sail artisan migrate
    vendor/bin/sail artisan elastic:migrate
   

8. (On first run) Create the initial user.

    vendor/bin/sail artisan db:seed --class UserSeeder
   

   The default username and password is admin@kcal.test.

Once the application finishes starting, navigate to http://127.0.0.1:8080 (or http://kcal.test:8080 if configured).