Laravel backend powering the Matryoshka website and API
This server application hosts both the API and the administrator panel for the Matryoshka Project.
Installing / Getting started
NOTE: Some dependencies have Operating System-specific installation instructions that are difficult to collate in this document. Please refer to the official documentation when possible for the latest official instructions for your OS.
Follow the steps below to install the application for local development:
# Please see the Laravel documentation for the latest requirements # https://laravel.com/docs/installation # Install PHP 7 from http://www.php.net/ # Enable or install the following PHP extensions: # GD2, OpenSSL, PDO, Mbstring, Tokenizer, XML, Ctype, JSON, BCMath, ZIP # Install composer from https://getcomposer.org/ # Install Node.js from https://nodejs.org/en/ # Install MySQL from https://www.mysql.com/ # Clone this repository to your device git clone firstname.lastname@example.org:matryoshkadoll/matryoshka-server.git cd matryoshka-server # Install dependencies composer install # for development composer install --optimize-autoloader --no-dev # for production # Copy one of our environment files to a new file called `.env` # For development, copy the `.env.development` file # For production, copy the `.env.production` file cp .env.development .env # Edit `.env` to suit your environment. For example, set the database credentials. # Run the application's installation script php artisan app:install --clean-install # Run with '-h' option for other options # And done! You're good to go! # Start your local server at 127.0.0.1:8000 php artisan serve
app/Console/Commands/Install.php for detailed information on what the local installation script does.
- Laravel - PHP Web Framework
Deploying / Publishing
See the deployment section in our docs:
This application uses SemVer for versioning.
For the versions available, see releases.
This application uses PHPUnit to run tests.
# To run all application tests, simply run: phpunit
A test coverage report in HTML format is generated in the
phpunit directory after running tests.
This application's code style strives to follow the PSR-2 style guide and is enforced with an
See the API section in our docs: