FlorisBoard Addons Backend Documentation

Welcome to the official documentation for FlorisBoard Addons Backend. This guide provides comprehensive information on setting up and running the Laravel application for the backend. Follow the steps below to get started with the FlorisBoard Addons Backend.

Table of Contents

• How to Run the Backend
• Development
  • Default Alias
  • Tools
    • Code Formatting
    • Static Analysis
    • Debug and dd
    • Testing
  • UI Documentation Link
  • Admin Panel Link
    • Default Credentials
  • Mail Link

How to Run the Backend

Before proceeding, ensure that Docker is installed on your system.

1. Copy the .env file:

   cp .env.example .env

2. Install Composer Dependencies:

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

3. Configure & use these recommended alias:

   alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'
   alias saila='sail artisan'
   alias sailp='sail bin pint'
   alias sails='sail bin phpstan analyze'

4. Run Docker Containers:

   sail up

5. Generate Application Key:

   saila key:generate

6. Create Local Storage for File Uploads:

   saila storage:link

7. Migrate the Database and Seed with Fake Data (for development):

   saila migrate && saila migrate:fresh --seed

Development

Default Alias

We recommend to configure these alias for easier development

    alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'
    alias saila='sail artisan'
    alias sailp='sail bin pint'
    alias sails='sail bin phpstan analyze'

Tools

Make sure to configure the default alias

Code Formatting

We're using laravel pint for code formatting you can run the code formatting using

sailp

Static Analysis

We're using larastan for static analysis make sure to run it occasionally to catch bugs

sails

Debug

When you want to debug a value instead of using the old dd you can take advantage of laravel ray

ray(...$values);

and you can see the result on http://localhost:8000. It's an open source laravel ray compatible service called buggregator.

Testing

We're using testing to make sure the logic works with different scenarios so make sure to use

saila test

to see if tests are passing

UI Documentation Link

Access the API documentation by visiting the following link: http://localhost/docs/api

Admin Panel Link

Access the admin panel through the following link: http://localhost/admin

Default Credentials

• Email: [email protected]
• Password: password

Mail Link

Access the Mailpit interface using the following link: http://localhost:8025