kpz-contactless-restaurant-backend

KPZ Contactless Restaurant Backend

About The Project

KPZ Contactless Restaurant Backend is a student project for KPZ - Conference of Team Projects of University of technology of Wrocław. This is a backend part of the app which is supposed to help restaurants with contactless customer service.

The app is to provide functionalities such as:

• Listing associated restaurants
• Ordering food
• Collecting points

Built With

Main technology

• Golang 1.15
• Echo - Go web framework
• ORM library for Golang
• PostgresSQL

Sub technology

• Echo Swagger - Automatically generated documentation
• Docker

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

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

• Docker

  Install Docker for your system
  

• Create .env file write

  DB_DSN="host=PRIVATE-IP user=postgres password=postgres dbname=postgres port=5432 sslmode=disable"
  SECRET_KEY="XXXX" -> JUST ANY https://randomkeygen.com 256-bit WEP Keys
  

Installation

1. Clone the repo

   git clone https://github.com/angrynerds-pl/kpz-contactless-restaurant-backend.git
   

2. Build docker images

   docker-compose build
   

3. Start docker service

   docker-compose up
   

Usage

To use swagger run docker and go on https://PRIVATE-IP:8585/swagger/index.html

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your_username/repo_name