Scribble

Requirements

• git
• docker-compose
• docker

Setup

# Clone Git repository
$ git clone [email protected]:PatrickHoward/ISPTermProject.git Scribble
$ cd Scribble

# Update Git submodules
$ git submodule update

# Build Docker images
$ docker-compose build

# Create and start Docker container stack
$ docker-compose up -d

# Stop all containers on the Docker stack
$ docker-compose down

Production

# Build images for production
$ docker-compose -f ./docker-compose.yml build

# Generate static files and deploy
docker-compose -f ./docker-compose.yml run scribble-client \
  && docker-compose -f ./docker-compose.yml scribble-server scribble-router

Environmental Variables

$ echo $PORT # The port that NGINX listens to for HTTP requests
80

$ echo $HTTPS_PORT # The port taht NGINX listens to for HTTPS requests
443

Endpoints

After starting the container stack, the contains can be accessed at the following locations.

• Client - http://localhost
• Server - http://api.localhost