Merge pull request #49 from devaslanphp/master

Merge master into dev

Author: heloufir

.dockerignore

@@ -0,0 +1,11 @@
+.github
+docs/
+github-contents/
+tests/
+.gitattributes
+.gitignore
+buildDocker.sh
+docker-compose.yml
+readme-logo.png
+README.md
+

.gitattributes

@@ -9,3 +9,5 @@
 /.github export-ignore
 CHANGELOG.md export-ignore
 .styleci.yml export-ignore
+
+run.sh text eol=lf

.github/workflows/docker-image.yml

@@ -0,0 +1,34 @@
+name: Docker Image CI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Docker login
+        env:
+          DOCKER_USER: ${{secrets.DOCKER_USER}}
+          DOCKER_PASSWORD: ${{secrets.DOCKER_PASSWORD}}
+        run: |
+          docker login -u $DOCKER_USER -p $DOCKER_PASSWORD
+      - name: Get repository release tag
+        id: timeseries
+        uses: pozetroninc/github-action-get-latest-release@master
+        with:
+          excludes: prerelease, draft
+          repository: ${{ github.repository }}
+      - name: Build Docker image
+        run: |
+          docker build --network=host -t ${{secrets.DOCKER_USER}}/helper:latest -t ${{secrets.DOCKER_USER}}/helper:${{ steps.timeseries.outputs.release }} .
+      - name: Docker push image
+        run: |
+          docker push ${{secrets.DOCKER_USER}}/helper
+          docker push ${{secrets.DOCKER_USER}}/helper:${{ steps.timeseries.outputs.release }}

Dockerfile

@@ -0,0 +1,27 @@
+# syntax=docker/dockerfile:1
+
+#Deriving the latest base image
+FROM node:16.17.0-bullseye-slim
+
+# Any working directory can be chosen as per choice like '/' or '/home' etc
+WORKDIR /app
+
+COPY .env.example .env
+
+COPY . .
+
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends software-properties-common gnupg2 wget && \
+    echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" | tee /etc/apt/sources.list.d/sury-php.list && \
+    wget -qO - https://packages.sury.org/php/apt.gpg | apt-key add - && \
+    apt-get update -y && \
+    apt-get install -y --no-install-recommends php8.1 php8.1-curl php8.1-xml php8.1-zip php8.1-gd php8.1-mbstring php8.1-mysql && \
+    apt-get update -y && \
+    apt-get install -y composer && \
+    composer update && \
+    composer install && \
+    npm install && \
+    php artisan key:generate && \
+    rm -rf /var/lib/apt/lists/*
+
+CMD [ "bash", "./run.sh"]

README.md

@@ -19,6 +19,10 @@
     <a href="https://devaslanphp.github.io/project-management" title="Go to project documentation">
         <img src="https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge" alt="view - Documentation">
     </a>
+    <br/>
+    <a href="https://hub.docker.com/r/eloufirhatim/helper/tags" title="Docker image">
+        <img src="https://img.shields.io/docker/v/eloufirhatim/helper?label=Docker&logo=docker&style=for-the-badge" alt="Docker image">
+    </a>
 </p>
 
 # Introduction
@@ -130,6 +134,9 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
 - **Release 1.2.1**
     - Add jira integration #36
     - New feature: Import jira projects / tickets
+- **Release 1.2.2**
+    - Add jira integration #36
+    - New feature: Import jira projects / tickets
 
 ## Support us
 

buildDocker.sh

@@ -0,0 +1 @@
+docker build --network=host -t devaslanphp/helper:latest .

docker-compose.yml

@@ -0,0 +1,47 @@
+version: "3.3"
+
+volumes:
+  mysql_data:
+
+services:
+  sqldb:
+    image: mysql:5.7
+    container_name: helper-mysql
+    volumes:
+      - mysql_data:/var/lib/mysql
+    environment:
+      - MYSQL_DATABASE=helper
+      - MYSQL_USER=helper
+      - MYSQL_PASSWORD=helper
+      - MYSQL_ROOT_PASSWORD=helper
+    command: --default-storage-engine innodb
+    restart: unless-stopped
+    healthcheck:
+      test: mysqladmin -p$$MYSQL_ROOT_PASSWORD ping -h localhost
+      interval: 20s
+      start_period: 10s
+      timeout: 10s
+      retries: 3
+  helper:
+    image: devaslanphp/helper:latest
+    container_name: helper-server
+    environment:
+      - DB_CONNECTION=mysql
+      - DB_HOST=sqldb
+      - DB_PORT=3306
+      - DB_DATABASE=helper
+      - DB_USERNAME=helper
+      - DB_PASSWORD=helper
+      - MAIL_MAILER=smtp
+      - MAIL_HOST=smtp.mailtrap.io
+      - MAIL_PORT=2525
+      - MAIL_USERNAME=your_username
+      - MAIL_PASSWORD=your_password
+      - MAIL_ENCRYPTION=tls
+    depends_on:
+      - sqldb
+    restart: "no"
+    ports:
+      - 8000:8000
+    volumes:
+      - /etc/localtime:/etc/localtime

docs/_sidebar.md

@@ -14,3 +14,6 @@
   - [Projects configuration](/customization?id=projects-configuration)
   - [Tickets configuration](/customization?id=tickets-configuration)
   - [Social authentication](/customization?id=social-authentication)
+- [Docker](/docker?id=docker)
+    - [Build image locally](/docker?id=build-image-locally)
+    - [Use the Docker hub image](/docker?id=use-the-docker-hub-image)

docs/docker.md

@@ -0,0 +1,31 @@
+# Docker
+
+The application is available as a Docker image too, and can be used in 2 ways:
+
+## Build image locally
+
+You can build the image locally in your development environment, by using the **Docker** files in the project root.
+
+To build the docker image you can execute the following command:
+
+```bash
+docker build --network=host -t devaslanphp/helper:latest .
+```
+
+After the image is created in your docker, you can use the following command to construct your docker container:
+
+```bash
+docker-compose up -d
+```
+
+This will create a docker container for you in a daemon mode.
+
+> This command uses the file `docker-compose.yml` existing in the project root folder, so before executing the `docker-compose` you need to update the environment variable in this folder.
+
+## Use the Docker hub image
+
+You can use the docker hub image instead of building the image locally [https://hub.docker.com/r/eloufirhatim/helper](https://hub.docker.com/r/eloufirhatim/helper).
+
+> You can refer to the `docker-compose.yml` file to have an example how to use the hub image instead of the local image
+
+> Important: The docker hub image is pushed automatically after a new release tag is created in the repository

run.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+php artisan queue:work &
+php artisan migrate
+php artisan db:seed
+npm run build
+php artisan optimize:clear
+php artisan serve --host 0.0.0.0