Link Search Menu Expand Document
Board Wars Documentation

Introduction

Table of contents

  1. Introduction

Starter

This section introduces building Board Wars and running it, either locally or remotely.

Docker

We can build Board Wars using docker. First, clone the repository from Github, then run the command at the base directory

    docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

This will create all images needed (if not already created), and start them up as containers.

Local Setup

Local setup involves building the project separately as a backend and frontend projects. Check out

Post Setup

After setup, an organization has to be registered before any authentication, authorization or service operation is carried out.

To do that, we make use of github oauth organization registration. So, before a company is registered, it must have been created from github and linked to the application.

Also, a public email is required to track and link github organization email to local server email authentication.