Skip to content

Running locally

Marcin Kralka edited this page Jan 29, 2024 · 6 revisions
  1. Either:

    • Download a zip with the repository files by clicking green Code button and then clicking Download ZIP (simplest);

    • or use git clone command in your operating system's console (recommended), but note that you might need to install git first.

      • After making sure you have git installed you just need to enter following command in your console: git clone https://github.com/Matriks404/mlc.git
  2. Build stylesheet using Sass:

    • On Windows get Sass here, then add it to to your PATH and using command line interpreter go to scripts/ directory and execute .\Build.Windows.bat.

    • On Unix-like operating systems (e.g. Linux, any BSD or macOS) install Sass using your package manager and using terminal go to scripts/ directory and execute ./Build.Unix.sh.

  3. Run a web server on your local machine (or somewhere else) using any server software you like to use with this project's site/ directory as a target location.

    • On Windows you can use PHP built-in web server. Alternatively use anything else, as it should work with any HTTP server.

      • If you want to use PHP built-in server first install appropriate version, add it to your PATH and then run script in the scripts/ directory called Run.Windows.bat.
    • On Unix-like operating systems (e.g. Linux, any BSD or macOS) you can figure it out on your own.

  4. Open localhost:<port> URL in your browser on local machine.

    • If you followed instructions for getting PHP installed on Windows, website is located at localhost:8888.

Website will also of course work for any device that is connected on your local network as long as you configured HTTP server properly and entered valid IP of your computer on other device's web browser (NOT localhost). If you use PHP built-in web server on Windows, this should work by default.

Clone this wiki locally