Fix Merge Issues for #55

bearlike · Jun 6, 2021 · ba41fce · ba41fce
1 parent 57e7edd
commit ba41fce
Show file tree

Hide file tree

Showing 35 changed files with 976 additions and 598 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,15 @@
+FROM php:7.2-apache
+LABEL in.thekrishna.rems.email="krishna.alagiri03@gmail.com"
+LABEL in.thekrishna.rems.authors="Krishnakanth, Mahalakshumi"
+LABEL in.thekrishna.rems.link="https://github.com/bearlike/REMS-For-Organisations"
+LABEL in.thekrishna.rems.title="Resources and Event Management System (REMS)"
+
+RUN rm /etc/apt/preferences.d/no-debian-php
+ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
+RUN chmod +x /usr/local/bin/install-php-extensions && sync && \
+    install-php-extensions gd xdebug
+RUN install-php-extensions pdo_mysql
+
+COPY . /var/www/html/
+COPY docker/secrets_.php /var/www/html/members
+RUN rm -r /var/www/html/docs /var/www/html/.git
diff --git a/README.md b/README.md
@@ -1,29 +1,36 @@
 <h1 align="center">
   <br>
-  <img src="https://i.imgur.com/w5PZAuO.png" alt="CMS For Organisations" height="250px">
+  <img src="https://cdn.thekrishna.in/img/common/rems.png" alt="CMS For Organisations" height="250px">
   <br>
 </h1>
 <h4 align="center">Responsive Resources and Event Management System for small organisations and clubs. Form Generator, Mailer, Certificate Generator and much more :)</h4>
 
 <p align="center">
-  <img src="https://img.shields.io/github/last-commit/K-Kraken/REMS-For-Organisations?color=blue&style=flat-square">
-  <a href="/LICENSE"><img src="https://img.shields.io/github/license/K-Kraken/REMS-For-Organisations.svg?style=flat-square"></a>
-  <a href="https://github.com/K-Kraken/REMS-For-Organisations/issues"><img src="https://img.shields.io/github/issues-raw/K-Kraken/REMS-For-Organisations?color=red&style=flat-square"/></a>
-    <a href="https://github.com/K-Kraken/REMS-For-Organisations/releases"><img src="https://img.shields.io/github/v/tag/K-Kraken/REMS-For-Organisations?label=stable&style=flat-square"/></a>
+  <img src="https://img.shields.io/github/last-commit/bearlike/REMS-For-Organisations?color=blue&style=flat-square">
+  <a href="/LICENSE"><img src="https://img.shields.io/github/license/bearlike/REMS-For-Organisations.svg?style=flat-square"></a>
+  <a href="https://github.com/bearlike/REMS-For-Organisations/issues"><img src="https://img.shields.io/github/issues-raw/bearlike/REMS-For-Organisations?color=red&style=flat-square"/></a>
+    <a href="https://github.com/bearlike/REMS-For-Organisations/releases"><img src="https://img.shields.io/github/v/tag/bearlike/REMS-For-Organisations?label=stable&style=flat-square"/></a>
 </p>
 
 
 
-
-
-
 ### Why are we doing it?
 We are running a chapter (club) at our college. We organize 20+ events for our 1500+ participants. It was a tedious process to manually make forms, certificates, advertising via mail so we decided to automate that process. Any organization, clubs or institutions looking for a similar service can fork our project and tweak it according to their needs.
 
 
 
 ## Getting Started
 
+### Running REMS in Docker (Easiest)
+Modify the default values in `docker/mysql/database.sql` and `docker-run-vanilla.sh` to your requirement. 
+By default, exposes to host port `8080`. A `krishnaalagiri/rems` and `mysql` container would be configured and deployed.
+```bash
+# From the root of the repository
+sudo chmod +x docker-run-vanilla.sh
+./docker-run-vanilla.sh 
+```
+
+
 ### Prerequisites
 What things you need to run the software:
 - A **web server** with **PHP** preferably Apache2.
@@ -32,11 +39,11 @@ What things you need to run the software:
 
 
 ### Installation
-1. Download the latest stable release from [here](https://github.com/K-Kraken/REMS-For-Organisations/releases)
+1. Download the latest stable release from [here](https://github.com/bearlike/REMS-For-Organisations/releases)
 2. Create and Import the Main Database dump for  **MySQL-MariaDB** from [here](/docs/files/Sample_REMS_Database.sql) 
 3. Create a Forms Database.
 4. Copy the files from this repository to a location in the root directory of the web server
-5. Rename `member/secrets.php_` to `member/secrets.php`
+5. Rename `member/secrets.php_` to `member/secrets_.php`
 6. Update your database credentials, databases names (Main and Forms) and API Keys in `member/secrets.php` and `public/cds-public.php`
 7. With your Web Server and MySQL server running, visit the site
    - ```
@@ -49,16 +56,16 @@ What things you need to run the software:
 
 ## Features and Screenshots (Click to enlarge)
 
-```bash
+```
 Tested on Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11 with 10.4.8-MariaDB
 ```
 
 ### Certificate Generation and Distribution System (CGDS)
 
 A two-ended system (Both for **admin** and **public**) that'll automatically  generate certificates and make them available for distribution. The admin will have to upload a **Certificate Template** and a **CSV file** with Participant Names, Position Awarded, and Event Name. The generated certificates would be later automatically made for distribution.
 
-| CDS Public (Collection)                                  | CDS Admin (Generation)                                   | Generated Certificates                         |
-| -------------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------------- |
+| CDS Public (Collection)                                  | CDS Admin (Generation)                                   | Generated Certificates                                   |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
 | <img src="https://i.imgur.com/gaMfSOr.png" width="650"/> | <img src="https://i.imgur.com/APt8LDL.png" width="650"/> | <img src="https://i.imgur.com/av6OHek.png" width="650"/> |
 
 ### Database Management
@@ -112,16 +119,16 @@ Perhaps our most desired feature, it gives an option to toggle the page between
 
 ## Authors
 
-| Authors             | Profile Links                            |
-| ------------------- | :--------------------------------------- |
-| **Krishna Alagiri** | [K-Kraken](https://github.com/K-Kraken/) |
-| **Mahalakshumi V**  | [mahavisvanathan](https://github.com/mahavisvanathan/) |
+| Krishnakanth Alagiri                                                                        | Mahalakshumi V                                                                                     |
+| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| [![f](https://avatars1.githubusercontent.com/u/39209037?s=86)](https://github.com/bearlike) | [![f](https://avatars2.githubusercontent.com/u/40058339?s=86)](https://github.com/mahavisvanathan) |
+| [@bearlike](https://github.com/bearlike)                                                    | [@mahavisvanathan](https://github.com/mahavisvanathan)                                             |
 
 
 ## Outside Contributors
-| Contributors | Profile Links                                 | PR                                                           |
-| ------------ | --------------------------------------------- | ------------------------------------------------------------ |
-| **Dhiraj V** | [dhirajv2000](https://github.com/dhirajv2000) | [#28](https://github.com/K-Kraken/REMS-For-Organisations/pull/28) |
+| Contributors | Profile Links                                 | PR                                                                |
+| ------------ | --------------------------------------------- | ----------------------------------------------------------------- |
+| **Dhiraj V** | [dhirajv2000](https://github.com/dhirajv2000) | [#28](https://github.com/bearlike/REMS-For-Organisations/pull/28) |
 
 ## Acknowledgments
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,38 @@
+version: '3'
+
+services:
+    rems-app:
+        image: krishna/rems:latest
+        ports: 
+            - 8080:80
+        volumes:
+            - rems_gen_certs:/var/www/html/public/Generated Certificate
+        networks:
+            - rems-network
+
+    rems-mysql:
+        image: mysql
+        ports:
+            - 3306:3306
+        volumes:
+            - rems_mysql:/var/lib/mysql
+            - ./docker/mysql:/docker-entrypoint-initdb.d
+        environment:
+            - MYSQL_ROOT_PASSWORD="0000" 
+            - MYSQL_DATABASE="db_cms" 
+        networks:
+            rems-network:
+                ipv4_address: 172.16.238.10
+
+networks:
+    rems-network:
+        driver: bridge
+        ipam:
+            driver: default
+            config:
+            - subnet: 172.16.238.0/24
+
+volumes:
+    rems_mysql:
+    rems_gen_certs:
+
diff --git a/docker-run-compose.sh b/docker-run-compose.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+echo -e "Building Image..."
+docker build -t krishnaalagiri/rems:latest .
+echo -e "Deploying Stack..."
+docker-compose up -d
diff --git a/docker-run-vanilla.sh b/docker-run-vanilla.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+docker stop "rems-mysql" && docker rm "rems-mysql"
+docker stop "rems-apache" && docker rm "rems-apache"
+docker network create --driver=bridge --subnet=172.16.238.0/24 "rems-network"
+docker volume rm "rems_mysql" && docker volume create "rems_mysql"
+
+docker run --name "rems-mysql" -v "rems_mysql":"/var/lib/mysql" -v "$PWD/docker/mysql":"/docker-entrypoint-initdb.d" -e MYSQL_ROOT_PASSWORD="0000" -p 3306:3306 -d --network "rems-network" --ip 172.16.238.10 mysql
+docker build -t krishnaalagiri/rems:latest .
+
+docker run --name "rems-apache" -d -p 8080:80 --network "rems-network" krishnaalagiri/rems:latest