Add content to README.md (#38)

* Add content to README.md

* Add project description

* Update README.md
This commit is contained in:
FUH22860 2023-06-23 14:32:57 +02:00 committed by GitHub
parent 6c1b7bd336
commit 688315441e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,3 +1,47 @@
# y4f
[![Deploy blazor to GitHub Pages](https://github.com/yummy4friends/y4f/actions/workflows/main.yml/badge.svg?branch=dev)](https://github.com/yummy4friends/y4f/actions/workflows/main.yml)
## Description (German)
Yummy4Friends ist eine benutzerfreundliche und visuell ansprechende Webapp zur Onlinebestellung von Speisen mit der dynamischen Einbindung einer Kunden- und Speisendatenbank unter Berücksichtigung von Sonderwünschen. Zur Kundenbindung wird auch die Verwaltung von Kundenrabatten, Vorbestellmöglichkeiten sowie konfigurierbare Abholtermine realisiert.
## Description (English)
Yummy4Friends is a user friendly and visually appealing WebApp for ordering food or other things online. Food or other stuff get dynamically fetched from a customer and food database while also taking into account special requests. To attract customers one can also offer limeted time sales/coupons, ordering in advance as well as being able to choosing their preferred pickup time.
## Tech Stack
[Blazor WebAssembly](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor)
## Dependecies
On Ubuntu our dependencies are:
```bash
nala install dotnet-sdk-7.0 docker-ce docker-ce-cli docker-buildx-plugin docker-compose-plugin
```
Dependency names will depend on your linux distribution.
For this this project you also need Traefik. Or you can use your own reverse proxy and edit the docker-compose files to reflect that.
## Running it
Clone the repo.
```bash
git clone https://github.com/yummy4friends/y4f.git && cd y4f
```
Start the website with docker-compose.
```bash
docker-compose up --build -d
```
Also start up the API.
```bash
cd src/WebApi/ && docker-compose up --build -d
```
This setup is for showcasing the project and is therefore not intended for production.