Xalok Go Documentation

Appearance

Mockup ​

Mockup is the base code with all design definitions.

The mockup templates must be isomorphic with Cobase templates definition.

IMPORTANT All design must work in Mockup with default values and in Starbase project. Any functionality doubt about parameterize and customize by project, please contact project responsible.

Structure ​

Mockup requires a project of Starbase to run because of dependencies.

(See Dependency structure in Structure)

Setup ​

Mockup project depends on a project to run.

To work only with styles Starbase can be avoided but the validation must be done in a complete deploy of Starbase

Assuming Vagrant context, mockup route is:

shell
www-data@localhost:/var/www/sites/enabled/st4/vendor/xalok-go/mockup$

Install npm dependencies with npm install.

Setup standalone ​

To work with mockup without vagrant and provisioning there are two options:

Composer ​

With composer installed, clone the Starbase project and install with composer:

shell
~$ git clone https://git.xalok.com/webflow/xalok-go-starbase.git
...
~$ cd xalok-go-starbase
~/xalok-go-starbase$ composer install --no-scripts
...

Clone Starbase

Create manually vendor/xalok-go folder inside project folder.

Inside vendor/xalog-go folder, clone mockup repository.

Checkout to branch.

shell
~$ git clone https://git.xalok.com/webflow/xalok-go-starbase.git
...
~$ cd xalok-go-starbase
~/xalok-go-starbase$ mkdir -p vendor/xalok-go
~/xalok-go-starbase$ cd vendor/xalok-go
~/xalok-go-starbase/vendor/xalok-go$ git clone https://git.xalok.com/webflow/xalok-go-mockup.git
~/xalok-go-starbase/vendor/xalok-go$ mv xalok-go-mockup mockup

This option is not recommended because the folder structure can change, but it allows no depend on composer neither PHP.

Local execution ​

To launch the project in local:

shell
www-data@localhost:/var/www/sites/enabled/st4/vendor/xalok-go/mockup$ npm run start

To generate statics and keep it listening to changes:

shell
www-data@localhost:/var/www/sites/enabled/st4/vendor/xalok-go/mockup$ npm run build

To execute both commands:

shell
www-data@localhost:/var/www/sites/enabled/st4/vendor/xalok-go/mockup$ npm run start & npm run build

In the same project domain with 3000 port the development server to mockup is available:

http://starbase.lo:3000/