Installation

Openjet is a private project, you need to have appropriate access right to gitlab.openjetlab.fr.

Warning

This article assumes you’re familiar with Composer, a dependency manager for PHP. It also assumes you have Composer installed globally.

Note

If you downloaded the Composer phar archive, you should use php composer.phar where this guide uses composer.

Tip

If you prefer to work with Docker head to this guide.

Initiating A New Project

To create a new project, run:

$ git clone git@gitlab.openjetlab.fr:backoffice/backoffice.git openjet
$ cd openjet

This will create a new Openjet project in openjet directory. After everything is in place, run the following commands:

$ cp .env.dist .env
$ composer install
$ bin/console openjet:database:install
$ bin/database-settings
$ bin/console openjet:install

Warning

During the openjet:install command you will be asked to provide important information. If you want to use default configuration, add --no-interaction option.

Installing assets

In order to see a fully functional frontend you will need to install its assets.

Openjet already has a Gulpfile.js, therefore you just need to get Gulp using Yarn.

Note

We recommend using stable versions (^1.0.0) of Yarn.

Having Yarn installed go to your project directory and run:

$ yarn install

And now you can use gulp for installing views, by just running:

$ bin/console bazinga:js-translation:dump public
$ yarn build

Accessing the Airline

Tip

We strongly recommend using the Symfony built-in web server by running the bin/console server:start 127.0.0.1:8000 command and then accessing http://127.0.0.1:8000 in your web browser to see the airline.

Note

The localhost’s 8000 port may be already occupied by some other process. If so you should try other ports, like for instance: bin/console server:start 127.0.0.1:8081 Want to know more about using a built-in server, see here.

You can log in as an administrator, with the credentials you have provided during the installation process. Since now you can play with your clean Openjet installation.

Accessing the Administration Panel

Note

Have a look at the /admin url, where you will find the administration panel. Remember that you have to be logged in as an administrator using the credentials provided while installing Openjet.

How to start developing? - Project Structure

After you have successfully gone through the installation process of Openjet you are probably going to start developing.

In the root directory of your project you will find these important subdirectories:

  • app/config/ - here you will be adding the yaml configuration files including routing, security, etc.
  • var/logs/ - these are the logs of your application
  • var/cache/ - this is the cache of you project
  • src/ - this is where you will be adding all you custom logic in appropriate component or bundle.

Tip

As it was mentioned before we are basing on Symfony, that is why we’ve adopted its approach to architecture. Read more in the Symfony documentation. Read also about the best practices while structuring your project.

Contributing

Tip

If you would like to contribute to Openjet - please go to the Contribution Guide