GitLab Project - Supportik

How to Contribute

  1. Setup Development Environment
  2. Log/Find a feature that requires action
  3. Create a feature branch, commit and push changes, and a Open Pull Request

Development Environment Setup

Overview

TBA

See: Development Details

Step 1. In GitLab

  1. Fork Supportik Repository
    1. Login/Register to GitLab - if you aren’t already ;).
    2. Go to GitLab Project: Supportik
    3. Click the Fork icon.

Step 2. On Host Development Machine

  1. Install Git
  2. Install Docker - Appendix: Docker
  3. Setup devel directory
    This is our root development directory which is shared with the development VM and containers.
    • Windows: C:/devel/
    • Mac/Linux: /devel/
  4. Clone your Fork locally
    1. Switch to devel directory
    2. git clone https://gitlab.com/<username>/supportik.git
  5. Install an IDE (that supports PHP/Web)
    • Recommended: VS Code
    • Alternatives:
      • TBA
  6. Setup project in IDE
  7. Run Docker - TBA -
    • Adjust the local directory path to ensure local project is available in Docker container
    • If on Windows (especially if you don’t have Hyper-V), use Docker-Machine
  8. Go to http://supportik.dev
  9. Get modifying!

Your first contribution

TBA

Appendix

Development Details

  • Service Side Language: PHP 7
    • Framework: Silex
    • Testing Framework: TBA - PHPUnit?
    • Library Management: Composer
  • Client Side Language: JS
    • Framework: VueJS
    • Static Type Checker: Flow
    • Testing Framework: TBA
  • Database:
    • PostgreSQL 10.2
  • Environment Management Tool:
    • Docker
  • Source Control:
    • Git via GitLab
  • Feature/Bug Tracking:
    • GitLab Issues

VS Code Setup

Incomplete

Docker

You need to install Docker localy to run, test and develop. The simplest way to use Docker is with Docker CE. However, Docker CE does not run on all systems. You should check if your system is supported under System Requirements before downloading. If your system does not support Docker CE, you will need to use Docker Toolbox. Either will work for the purpose of development of Supportik.