Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 2.41 KB

Development.md

File metadata and controls

57 lines (46 loc) · 2.41 KB
Raw

SUPLA Cloud - Development

This description shows how to install launch the SUPLA Cloud in developer environment. It does not apply to production instances.

Please note, that this only installs SUPLA Cloud, without supla-server. Managing the devices from SUPLA Cloud only is impossible. Development instance uses mock of supla-server by default.

The first launch

  1. Install PHP v7.3. On Windows machines, you can install XAMPP.

  2. Install MySQL database server (XAMPP already contains it).

  3. Install Node JS LTS. Version 14.x with NPM 7.x is proved to be working.

  4. Install Git, then fork and clone the repository with git clone command.

  5. Go to the cloned directory.

  6. Install Composer.

  7. Install project's PHP dependencies with composer install. During the installation, copmoser will ask you for a bunch of things. For the development environment, the most important are:

    1. database_* - configuration of your database connection
    2. supla_server - set it to localhost:8008
    3. recaptcha_enabled - set it to false

    You can leave the defaults for all of the other settings. If you made a mistake, you can fix it by editing the app/config/parameters.yml file.

  8. Install the frontend dependencies and build it for the first time with

    composer run-script webpack

  9. Initialize the database and load sample data with

    php bin/console cache:clear --no-warmup -e dev
php bin/console supla:dev:dropAndLoadFixtures -e dev

Development

  1. Run backend with 
    php7.3 -S 127.0.0.1:8008 -t web web/router.php
  2. Run webpack dev server (frontend) with 
    cd src/frontend && npm run serve
  3. Enter http://localhost:8080 to see the application.
  4. Login with [email protected] and pass (this is a sample account).

Contributing

  1. See what needs to be done or create an issue you would like to solve.
  2. Tell us you are willing to help with the issue in comments.
  3. Fix the issue on a separate branch on your fork.
  4. Make a Pull Request with your work.
  5. Become a contributor of SUPLA project!