Installation

Note

CEWW doesn’t use labeled or numbered releases. The code in the master branch of the repository should be runnable.

Make sure the requirements are satisfied.

The CEWW application is based on Symfony 4.4. Installation follows the normal process for installing a Symfony application.

  1. Get the code from GitHub.

git clone https://github.com/sfu-dhil/ceww.git

  1. Get the submodules from Git. There is quite a bit of reusable code in the application, and it’s organized with git submodules. Navigate into the ‘ceww’ directory and type:

git submodule init
git submodule update --recursive --remote

  1. Create a database and database user.

Note

On Windows you can use a server suite like XAMPP or WAMP -make sure you get the right PHP version.

create database ceww;
create user if not exists ceww@localhost;
grant all on ceww.* to ceww@localhost;
set password for ceww@localhost = password('hotpockets');

Note

Composer should ask for these automatically when installing the dependencies. In case if it doesn’t, you can later pass the database parameters to the ‘parameters.yml’ file under the ‘ceww/app/config/’ manually.

  1. Install Composer if it isn’t already installed somewhere. Make sure you do a global installation.

  2. Install the Composer dependencies (make sure the working directory is ‘ceww’). Composer will ask for some configuration variables during installation.

composer install --no-dev -o

Sometimes Composer runs out of memory. If that happens, try this alternate.

php -d memory_limit=-1 `which composer` install --no-dev -o

  1. Update file permissions if needed. The user running the web server must be able to write to var/cache/* and var/logs/* and var/sessions/*. The symfony docs provide recommended commands depending on your OS.

  2. Please follow the instructions in the config.rst file to set up the configuration settings for this project.

  3. Load the schema into the database. This is done with the Symfony console.

./bin/console doctrine:schema:update --force

  1. Create an application user with full admin privileges. This is also done with the Symfony console.

./bin/console nines:create:user

  1. If you haven’t installed npm and yarn globally, you will have to install them. You could do this by running the below commands in the terminal.

sudo apt install npm
sudo npm install --global yarn

  1. If you have installed npm and yarn globally, then set up yarn for this project by running the below command inside project directory.

yarn install

  1. Configure the web server. The application’s public/ directory must be accessible to the world. Symfony provides example configurations for most server setups.

  2. The documentation module should be built seperately. You need the Sphinx to be already installed. Check the DHIL Documentation Guide for more information.

Navigate to the ‘ceww/docs’ directory in the command line and type:

make html

  1. Start the Symfony server by using the below command and navigate to the link displayed.

symfony server:start

At this point, the web interface should be up and running, and you should be able to login by following the Login link in the top right menu bar.

  1. Once everything is done, you should stop the Symfomny server. Before you close the terminal, make sure to stop the server using this command.

symfony server:stop

That should be it.