kcal/README.md

1.6 KiB
Raw Blame History

kcal the personal food nutrition journal

CI Status Coverage \status

Development

Laravel Sail

Prerequisites

  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 finishing starting, navigate to http://127.0.0.1:8080 (or http://kcal.test:8080 if configured).