Project Title

Project Description

Enter project description here.

Build Directions

Dependencies

The project is built using Docker which simplifies the host dependency requirements. You'll want to install Docker using the preferred method for your operating system. Here are some examples:

APT (Ubuntu, Debian, Elementary, Deepin, etc)

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu <codename> stable"
sudo apt install docker-ce docker-compose

NOTE: Replace <codename> with your OS codename(xenial, bionic, etc)

YUM (Pre 8 CENTOS and RHEL)

sudo yum-utils device-mapper-persistent-data lvm2 epel-release
sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
sudo yum install docker-ce docker-compose

DNF (8+ CENTOS and RHEL, FEDORA)

sudo dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
sudo dnf install docker-ce docker-compose

PACMAN (Arch, Manjaro)

sudo pacman -Sy docker docker-compose

You will probably want to add your user to the docker group to avoid having to use sudo for everything. You can do that by using the command sudo usermod -aG docker $(whoami)

NOTE: You will have to log out and log back in to process the user group change on your account.

Host Configuration

Enable Docker

sudo systemctl enable docker
sudo systemctl start docker

Clone Repository

git clone <git_address> /path/to/desired/destination

NOTE: You can omit the path if you want to clone it to the current directory

Run Instance

cd /path/to/cloned/repo
docker-compose up -d

NOTE: You can omit the -d flag if you do not want to run detached.

Connecting to the Application

The project is currently configured to forward port 3000 of the web application container to the host. You should be able to access the application by pointing your web browser to localhost:3000

Rebuilding Project

Rebuild project using cached images:

docker stop $(docker ps -a -q)
docker-compose build
docker-compose up

Rebuild project without using cached images:

docker stop $(docker ps -a -q)
docker system prune -af
docker-compose up

NOTE: You may need to delete the node_modules directories if the project fails to build