RomanNum3ral
/
kcal
mirror of https://github.com/kcal-app/kcal.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
the personal food nutrition journal
288 Commits 3 Branches 1 Tag 28 MiB
PHP 89.5%
Blade 10.4%
Dockerfile 0.1%
Go to file
Christopher C. Wells 0961a37ef2 Sync user seeding and README 2021-04-05 16:29:25 -07:00
.github Keep default path for coverage output in CI 2021-04-02 23:42:27 -07:00
app Remove breeze boilerplate verification and registration code 2021-04-05 05:41:34 -07:00
bootstrap Initial commit -- Laravel base app 2020-12-21 09:46:31 -08:00
config Add Goals API endpoint 2021-04-02 23:42:27 -07:00
database Sync user seeding and README 2021-04-05 16:29:25 -07:00
elastic/migrations Use babenkoivan Elasticsearch ecosystem 2021-03-04 22:17:33 -08:00
public Prevent tag overlflow in edit views 2021-04-04 13:10:31 -07:00
resources Remove breeze boilerplate verification and registration code 2021-04-05 05:41:34 -07:00
routes Remove breeze boilerplate verification and registration code 2021-04-05 05:41:34 -07:00
storage Add `.gitignore` to `storage/media-library` 2021-03-13 14:43:09 -08:00
tests Add missing user authentication tests 2021-04-05 05:41:53 -07:00
.editorconfig Initial commit -- Laravel base app 2020-12-21 09:46:31 -08:00
.env.local.example Add configurations and documentation for Laravel Sail 2021-04-05 16:21:10 -07:00
.env.prod.example Add configurations and documentation for Laravel Sail 2021-04-05 16:21:10 -07:00
.gitattributes Initial commit -- Laravel base app 2020-12-21 09:46:31 -08:00
.gitignore Add coverage/coverall base support 2021-04-02 23:42:27 -07:00
.phpstorm.meta.php Add initial recipe image support 2021-03-12 20:48:08 -08:00
.styleci.yml Initial commit -- Laravel base app 2020-12-21 09:46:31 -08:00
ATTRIBUTIONS.md Remove icon nav elements 2021-03-27 21:01:34 -07:00
LICENSE Add LICENSE file 2021-01-03 14:30:18 -08:00
README.md Sync user seeding and README 2021-04-05 16:29:25 -07:00
_ide_helper.php Update composer dependencies 2021-04-02 23:45:16 -07:00
artisan Initial commit -- Laravel base app 2020-12-21 09:46:31 -08:00
composer.json Require `doctrine/dbal` 2021-04-05 05:49:12 -07:00
composer.lock Require `doctrine/dbal` 2021-04-05 05:49:12 -07:00
docker-compose.yml Add configurations and documentation for Laravel Sail 2021-04-05 16:21:10 -07:00
package-lock.json Update to PostCSS 8 2021-04-02 23:54:12 -07:00
package.json Update to PostCSS 8 2021-04-02 23:54:12 -07:00
phpstan.neon.dist Add phpstan support 2021-01-24 19:43:59 -08:00
phpunit.xml Enable parallel testing in CI 2021-04-02 23:42:27 -07:00
server.php Initial commit -- Laravel base app 2020-12-21 09:46:31 -08:00
tailwind.config.js Add frontend support for Quill JSON strings 2021-03-08 08:40:36 -08:00
webpack.mix.js Add Quill editor for recipe description 2021-03-08 08:40:36 -08:00

README.md

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).