This project is a Drupal 9 SEC's internal site Catalog.
- Catalog - https://catalog.sec.gov
Service | Link |
---|---|
Acquia URL | https://cloud.acquia.com/a/applications/c934299e-58d4-4c50-8da4-246726de9622 |
GitLab | https://jira.jiratracker.com/sec/datacatalog/ |
- Request access to GitLab and Acquia Cloud.
- Ensure that your computer meets the minimum installation requirements for Lando v3.0.26 and Docker 2.5.0.1.
- Install Docker 2.5.0.1
- Install Lando v3.0.26
- Setup a SSH key that can be used for GitLab and the Acquia Cloud (Use same SSH key for both accounts).
- Install necessary tools listed below:
- Start a command line tool to configure Git.
- Set username and email (Change email and name value to your work email and name).
$ git config --global user.name "Your Name" $ git config --global user.email "[email protected]"
- Set default Linux (LF) line ending instead of Windows (CRLF).
$ git config --global core.autolf true $ git config --global core.autocrlf false
- Allow Git to have longpath.
$ git config --global core.longpaths true
-
Clone repository using a command line tool. By default, Git names this "origin" on your local.
$ git clone [email protected]:sec/datacatalog.git ~/sites/catalog/
-
Change directory to catalog project
$ cd ~/sites/catalog/
-
Start local LAMP stack with Lando (Docker will start automatically if not, run Docker manually)
$ lando start
-
Login to Acquia CLI (acli) Note: Only required if you are building lando project from scratch or after
$ lando destroy
.$ lando acli auth:login
Follow the prompts to complete setting up Acquia CLI.
- Would you like to share anonymous performance usage and data? (yes/no) - [No]
- Do you want to open this page to generate a token now? (yes/no) - [No]
- Please enter your API Key: - [Generate this from Acquia: https://cloud.acquia.com/a/profile/tokens]
- Please enter your API Secret (input will be hidden): - [Generate this from Acquia: https://cloud.acquia.com/a/profile/tokens]
-
Pull database locally.
$ lando pulldb
-
Run database import command to import database locally.
Site Command Catalog $ lando db-import catalogdb.sql -h catalogdb
-
Initialize a project.
Site Command Catalog $ lando initproject-catalog
- Install VNC Viewer
- Open VNC Viewer and connect to localhost:5902
- Start a command line tool and change directory to catalog project.
$ cd ~/sites/catalog/
- Initialize Behat.
$ lando initbehat
- Run Behat command.
Site Command Catalog $ lando behat-catalog
Below is a list of useful command for local lando setup. Use $ lando --help
command to display additional commands.
Command | Explanation |
---|---|
$ lando acli |
Acquia CLI is a command-line interface for interacting with Cloud Platform services. ***WARNING*** this command interacts with Acquia Cloud Environments. |
$ lando acli-drush |
Runs drush command on Acquia Cloud given site and environment. ***WARNING*** this command interacts with Acquia Cloud Environments. |
$ lando behat |
Runs Behat command without any Behat Parameters. |
$ lando behat-catalog |
Runs Behat command for local catalog site. |
$ lando composer |
Runs composer commands |
$ lando drush |
Allows you to run drush locally. [Usage - lando drush cr] |
$ lando gulp |
Runs gulp commands |
$ lando info |
Prints info about your app |
$ lando initbehat |
Runs npm install and composer install for Behat and WDIO. |
$ lando initproject-catalog |
Runs cr, updb, cim, user-create (lando) with admin permissions on local catalog site. |
$ lando login-investor |
Creates one-time login link as admin for local investor site. |
$ lando login-catalog |
Creates one-time login link as admin for local catalog site. |
$ lando node |
Runs node commands |
$ lando npm |
Runs npm commands |
$ lando php |
Runs php commands |
$ lando pulldb |
Pulls database down locally. |
$ lando rebuild |
Rebuilds your app from scratch, preserving data |
$ lando restart |
Restarts your app |
$ lando ssh |
Drops into a shell on a service, runs commands |
$ lando start |
Starts your app |
$ lando stop |
Stops your app |
$ lando theme-catalog-build |
Runs npm install and compiles catalog theme sass. |
$ lando xdebug-off |
Disable xdebug for Apache. |
$ lando xdebug-on |
Enable xdebug for Apache. |