tree: 943eea59abd2144a5746ac7fff3fbfd2da871a98 [path history] [tgz]
  1. bin/
  2. components/
  3. config/
  4. content/
  5. migrations/
  6. public/
  7. src/
  8. templates/
  9. .env
  10. .gitignore
  11. composer.json
  12. composer.lock
  13. readme.md
  14. symfony.lock
readme.md

1. Getting started

The LeafOS website runs on Symfony 6.2. You can check the Symfony documentation for the framework requirements. There are no additional requirements other than those.

After the requirements have been met, you can install the required dependencies by running composer install.

2. Running the site

There are two ways to run the site locally: by using PHP built-in webserver or by using Apache/Nginx.

Method 1: Using the PHP built-in server

After you've installed the required dependencies, you can start the PHP server by running the following command from the project root:

php -S localhost:8000 -t public/

After that, you can check the site by going to localhost:8000 on your browser. If the port 8000 is in use in your machine, simple change it to something else.

Method 2: using Apache/Nginx

Both Apache and Nginx are supported by Symfony. There is a dedicated section on Symfony documentation for that, please refer to this page in order to configure Apache/Nginx.