Giter Club home page Giter Club logo

catalogtest's Introduction

Project Details

This project is a Drupal 9 SEC's internal site Catalog.

Technology Stack

Service Link
Acquia URL https://cloud.acquia.com/a/applications/c934299e-58d4-4c50-8da4-246726de9622
GitLab https://jira.jiratracker.com/sec/datacatalog/

Getting Started

  1. Request access to GitLab and Acquia Cloud.
  2. Ensure that your computer meets the minimum installation requirements for Lando v3.0.26 and Docker 2.5.0.1.
  3. Install Docker 2.5.0.1
  4. Install Lando v3.0.26
  5. Setup a SSH key that can be used for GitLab and the Acquia Cloud (Use same SSH key for both accounts).
    1. Setup GitLab SSH Keys
    2. Setup Acquia Cloud SSH Keys
  6. Install necessary tools listed below:
    1. Command line tools:
      1. GitBash - Required
      2. cmder for better command-line support - Optional
      3. Windows Terminal - Optional
    2. Code Editors:
      1. VSCode - Required
      2. Notepad++ - Required
      3. PhpStorm - Optional

Configure Git

  1. Start a command line tool to configure Git.
  2. 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]"
    
  3. Set default Linux (LF) line ending instead of Windows (CRLF).
    $ git config --global core.autolf true
    $ git config --global core.autocrlf false
    
  4. Allow Git to have longpath.
    $ git config --global core.longpaths true
    

Setup Local Environment

  1. 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/
    
  2. Change directory to catalog project

    $ cd ~/sites/catalog/
    
  3. Start local LAMP stack with Lando (Docker will start automatically if not, run Docker manually)

    $ lando start
    
  4. 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.

  5. Pull database locally.

    $ lando pulldb
    
  6. Run database import command to import database locally.

    Site Command
    Catalog $ lando db-import catalogdb.sql -h catalogdb
  7. Initialize a project.

    Site Command
    Catalog $ lando initproject-catalog

Setup Behat Testing Environment

  1. Install VNC Viewer
  2. Open VNC Viewer and connect to localhost:5902
  3. Start a command line tool and change directory to catalog project.
    $ cd ~/sites/catalog/
    
  4. Initialize Behat.
    $ lando initbehat
    
  5. Run Behat command.
    Site Command
    Catalog $ lando behat-catalog

Useful commands

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.

catalogtest's People

Contributors

malam0180 avatar msalam0180 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.