Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 1.99 KB

README.md

File metadata and controls

85 lines (59 loc) · 1.99 KB
Raw

CheckBuddy - A simple laravel checklist demo app

Test the application

CheckBuddy

CheckBuddy is a simple laravel checklist demo app. It is a simple app that allows you to create checklists and add items to them. You can also mark items as completed and delete them.

Features

Backend

  • Laravel 10
  • Laravel Fortify for authentication (login, registration & password reset)
  • Laravel Sail for local development
  • Laravel Pint for backend linting
  • MySQL database

Frontend SPA

  • Vue 3
  • Vuetify 3
  • Vue router
  • ESLint for frontend linting

Installation

Clone the repository and init your environment:

git clone [email protected]:jhm-ciberman/todo-laravel-app.git
cd todo-laravel-app
cp .env.example .env

The project uses Laravel Sail for local development. You can find the documentation here. The first time you run the project you need to install the dependencies:

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    laravelsail/php82-composer:latest \
    composer install --ignore-platform-reqs

Then you can start the project:

./vendor/bin/sail up -d

Then, the regular stuff:

sail artisan key:generate
sail artisan migrate
sail artisan db:seed
sail npm install
sail npm run dev

You can now access the project at http://localhost.

Testing

You can run the tests with:

sail artisan test

Linting

To lint the code you can run Laravel Pint for the backend and ESLint for the frontend:

sail pint            # Lint backend
sail npm run lint    # Lint frontend

Mail

The Sail environment comes with Mailpit. You can access it at http://localhost:8025 and check the emails sent by the app.