QFox

• Live Demo: http://qfox.holy-pond-07793.pktriot.net

This project was bootstrapped with Parcel, Composer, Laravel, and Docker.

Installation

Warning: The following steps will do a clean install of the project, and all the existing data related to it will be erased.

Linux

Prerequisites

Your Linux system should have the following installed first:

• GIT
• Docker >= 18.09.3 (follow this guide to install Docker on Ubuntu)
• Docker Compose >= 1.23.2 (follow this guide to install Docker Compose)

Steps to Install

• First, fork this repository and clone it to your local machine (replace YOUR_USERNAME with your Gitlab account's username).

$ git clone https://gitlab.com/YOUR_USERNAME/qfox
$ cd qfox

• Then, run the following command and go grab a cup of water 🥤 while waiting for it to finish (it will take a few minutes):

$ sudo bash ./cmd/installation-linux.sh

• Once the command finishes, run this one last command and you're good to go:

$ docker-compose up

• Open your browser and head to http://localhost:1234. Enjoy coding 🎉!

Windows

Prerequisites

Your Windows system should have the following installed first:

• GIT
• A console emulator (GIT Bash or Cmder)
• Docker >= 18.09.3 (follow this guide to install Docker on Windows)
• Docker Compose >= 1.23.2 (you can skip installing Docker Compose as it is already included along with Docker Desktop for Windows)

Steps to Install

All of the following commands below must be run within GIT Bash or Cmder.

• First, fork this repository and clone it to your local machine (replace YOUR_USERNAME with your Gitlab account's username).

$ git clone https://gitlab.com/YOUR_USERNAME/qfox
$ cd qfox

• Optional step: If you're using GIT Bash to install, you may have to run the following commands first:

$ echo "alias docker='winpty docker'" >> ~/.bash_profile
$ echo "alias docker-compose='winpty docker-compose'" >> ~/.bash_profile
$ source ~/.bash_profile

• Then, run the following command and go grab a cup of water 🥤 while waiting for it to finish (it will take a few minutes):

$ bash ./cmd/installation-windows.sh

• Once the command finishes, run this one last command and you're good to go:

$ docker-compose up

• Open your browser and head to http://localhost:1234. Enjoy coding 🎉!

Note: Share your drive with Docker Desktop should it ask you to do so.