Installing with the skeleton #

This page is for developers who install a DXP project for the first time. It follows the skeleton's installation guide (sections 3 to 11) in a shorter form and links to the pages that explain each step. Allow about 30 minutes on a prepared machine (Versions you need).

Contents #

1. Two ways to start
2. The steps
3. After the install
4. Save points
5. When a step fails

Two ways to start #

create-project downloads the packages, runs the Flex recipes and the post-install scripts (assets:install, cache:clear).

The steps #

1. Create the project.

   composer create-project se7enxweb/exponential-platform-dxp-skeleton my-project
   cd my-project

2. Configure the environment in .env.local, never in .env, and never commit it (Environment variables).

   cp .env .env.local
   $EDITOR .env.local

3. Create the database (MySQL, MariaDB or PostgreSQL) or set the SQLite DSN (Databases, SQLite for development).

4. Install the schema and seed data.

   php bin/console exponential:install exponential-oss

   The argument is the install type; exponential-oss is the default. --skip-indexing skips the automatic reindex (Console commands).

5. Set the permissions for the web server user on var/ and public/var/ (File permissions).

6. Build the site assets.

   source ~/.nvm/nvm.sh && nvm use 20
   yarn install
   yarn dev

7. Build the administration assets.

   php bin/console assets:install --symlink --relative public
   yarn ibexa:build

8. Generate the JWT keypair for the REST API (JWT authentication).

   php bin/console lexik:jwt:generate-keypair

9. Generate the GraphQL schema (GraphQL).

   php bin/console ibexa:graphql:generate-schema

10. Clear the cache and build the search index.

    php bin/console cache:clear
    php bin/console exponential:reindex

11. Start a development server.

    symfony server:start

After the install #

The seed data creates an administrator account whose sign-in is printed in the public installation guide. Change its password in the administration interface right away, before the site is reachable from anywhere else.

Save points #

The guide suggests a Git commit after each stage, so you can return to a working state:

git init && git add -A && git commit -m "Added: project created from the DXP skeleton"
git add composer.lock && git commit -m "Updated: locked vendor dependencies"

Before git add -A, check that .gitignore excludes .env.local, config/jwt/*.pem, var/ and vendor/ (Develop with Git).

When a step fails #

Related pages #

• DXP skeleton: create-project and a documented install
• Environment variables
• Day-to-day commands
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.