LMMS's official website
Switch branches/tags
Clone or download

README.md

lmms.io

This repo contains the source for LMMS's website located at https://lmms.io.

How to test the website locally

  1. Clone the code

    $ git clone https://github.com/LMMS/lmms.io.git
  2. Get Composer

    This project uses Composer for dependency management. You'll have to fetch those dependencies using composer. For this, you must have Composer installed on your system. For quickly installing Composer locally on *nix, run:

    $ cd lmms.io
    $ curl -sS https://getcomposer.org/installer | php

    For installing Composer locally on Windows (i.e. Wamp), run:

    > cd lmms.io
    > php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));"

    Note: For this to work on Windows you need the php.exe processor to be on your path, usually located in c:\wamp\bin\php\phpx.y.z

    For instructions for other OSs or for installing globally, visit Composer's Getting Started document.

  3. Fetch dependencies using composer

    When you downloaded composer locally using the instructions above, fetch the dependencies by running

    $ php composer.phar install

    You'll have to run this comand every time the dependencies in composer.json change.

    Note: For macOS, some dependencies must be installed manually.

  4. Configure local server

    Apache:

    <Directory /home/user/lmms.io/public/>
    	# add fallback resource to Apache config
    	FallbackResource /index.php
    </Directory>

    Nginx:

    # go to our front controller if none of them exists
    location / {
    	try_files $uri $uri/ /index.php?$args;
    }
  5. Start local server

    $ php -S localhost:8000 -t ./public/

    You can then open http://localhost:8000/ in a browser.