Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 2.08 KB

README.md

File metadata and controls

42 lines (33 loc) · 2.08 KB
Raw

Charpstar's 3D asset management system

The contents of this repository were developed as part of the KTH course DD1393 Mjukvarukonstruktion (MVK) / Software Construction. While extensive project documentation has been provided, below aims to provide more technical supporting materials. This README file covers:

  • Docker containerisation
  • Reverse proxy protection
  • PostgreSQL database setup
  • Postman data
  • UI routes

Docker

Docker provides containerisation to facilitate mobility and migration of the contents on the server.

To create the containers, run first 01-buildImage.sh and then 02-createContainer.sh in both client and server folder. The client container will be called ui and the server container will be called backend. All uploaded files are located in /charpstarfiles

Core functionalities:

  • To start a container, run docker start $NAME
  • To stop a container, run docker stop $NAME
  • To see container status, run docker ps
  • For more docker commands, see the Docker documentation

Reverse proxy

TBD

PostgreSQL

The pg_dump command has been executed to recreate the database schema. Executing the PostgreSQL code can recreate the database, including its relations, enums and views. No data is recreated. For more commands, see the pSQL documentation.

Postman

The postman file illustrates the back-end end-points, which are used by the front-end AS an API and thus constitute the backbone of the platform. See the postman webpage for more information.

UI routes

The routes used for the UI are:

/ -> login  
/home -> admin panel
/modeller/:id -> modeller model list
/user/:id -> user view
/user/:id/orders -> user orders
/order/:id -> order overview
/order/:id/models -> order models
/model/:id -> model products