README

A skeleton to start a new website. Build with sy/bootstrap

Requirements

Start a new project with

composer create-project sy/project [DIRECTORY]

A command line interface will guide you for generating these configuration files when you create a new project.

Create the file [DOCUMENT ROOT]/protected/conf/database.ini

Example:

host = localhost
port = 3306
dbname = mydatabase
username = myuser
password = mypassword
charset = utf8mb4

Create the file [DOCUMENT ROOT]/protected/conf/smtp.ini

Example:

host = smtp.gmail.com
username = user@example.com
password = mypassword
port = 587
encryption = tls

When a new project is created, the database is created with this SQL script: protected/sql/V1__init.sql

We use Flyway to manage database changes. Here is the composer custom command:

composer db [FLYWAY COMMAND]

Flyway commands:

Example:

composer db migrate

We have a composer custom command for building CSS and JS assets:

composer build

But it's recommended to install NodeJS and Gulp if you have to rebuild frequently the CSS or JS.

Go to the project folder and install project dependencies

npm install

To build css (protected/scss/app.scss -> assets/css/app.css)

gulp css

To build js (protected/js/*.js -> assets/js/app.js)

gulp js

Check the coding style

composer check [FILE or DIRECTORY]

Format the coding style

composer format [FILE or DIRECTORY]

Example:

composer format protected/src

Coding standard ruleset used: sy/coding-standard