marek-02 / maze

Maze

Support for gamification of computer networking classes
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Acknowledgments

About The Project

Engineering Thesis "Support for gamification of computer networking classes".
Authors: Julia Szpak, Ewa Miklewska, Jakub Stępień.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Backend setup with docker

We go to the "api" folder. If we execute the command for the first time:

docker-compose up --build

If we run the backend using the docker again, we can omit the --build option.

Frontend setup with docker

We go to the "frontend" folder. If we execute the command for the first time:

docker-compose up --build

If we run the backend using the docker again, we can omit the --build option.

General setup with docker (production version)

We go to the main folder ("maze"). From this folder, execute the following command:

docker-compose up -d --build

The above command will run both the backend and the frontend.

(back to top)

Acknowledgments

• ...
• ...
• ...

(back to top)