scgs-web

Web interface for nf-core-scgs pipeline

View project on GitHub

Introduction

This website application is based on Laravel framework.

Usage

  1. Prerequisites
    $ cp .env.example .env
    $ vi .env # optional
    
  2. Autoloader Optimization
    $ rm -f composer.lock package-lock.json # optional, slow
    $ composer install --optimize-autoloader --no-dev
    
  3. Compiling Assets
    $ npm install && npm run production
    
  4. Test using docker compose
    $ vi docker-compose.yml # optional
    $ mkdir -p pv pv/seq pv/db pv/redis pv/mysql
    $ docker-compose up # or docker-compose up -d
    
  5. Test using skaffold for k8s

    • Create a namespace: skaffold

    • Prepare all PVs for the PVC

    • test in dev mode

$ skaffold dev

License

Both the Laravel framework and website application are open-sourced software licensed under the MIT license.

Contact

Yanhai Gong

Shiqi Zhou