https://github.com/mandarine-io/backend
Server for web and mobile application Mandarine
https://github.com/mandarine-io/backend
docker docker-compose docsify gin-gonic github-actions gocron golang gorm mailhog minio nginx postgis postgresql redis s3 smtp testcontainers
Last synced: 6 months ago
JSON representation
Server for web and mobile application Mandarine
- Host: GitHub
- URL: https://github.com/mandarine-io/backend
- Owner: mandarine-io
- License: apache-2.0
- Created: 2024-10-05T07:37:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T15:03:54.000Z (12 months ago)
- Last Synced: 2024-10-23T17:57:04.587Z (12 months ago)
- Topics: docker, docker-compose, docsify, gin-gonic, github-actions, gocron, golang, gorm, mailhog, minio, nginx, postgis, postgresql, redis, s3, smtp, testcontainers
- Language: Go
- Homepage: https://docs.mandarine-app.ru/
- Size: 780 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Backend
**Mandarine** - это платформа для записи на услуги красоты и ухода, объединяющая клиентов и мастеров. Здесь мы изучим
один из ее компонентов - *сервер*.
Mandarine имеет клиент-серверную архитектуру, поэтому сервер инкапсулирует достаточно много функционала:
+ **Регистрация и авторизация**
+ **Управление аккаунтами**
+ **Профиль, услуги, портфолио мастеров**
+ **Формирование расписаний и запись на услуги**
+ **Поиск мастеров**
+ **Отзывы о мастерах и их рейтинг**
+ **Уведомления**
+ **И много другого**
## Быстрый старт
Для того чтобы запустить проект локально и ознакомиться с его основными функциями, вам нужно:
### Предварительные условия
Подготовить следующие инструменты:
- [Golang](https://go.dev/)
- [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
- [Make](https://www.gnu.org/software/make/) (опционально)
### Клонирование проекта
Склонировать репозиторий сервера:
```bash
git clone https://github.com/mandarine-io/backend
```
### Среда выполнения
Запустить среду выполнения в Docker. Для этого выполните команду:
```bash
docker compose -f docker-compose.local.yml up -d
```
### Конфигурация
Используйте `config/config.default.yaml` в качестве шаблона для создания своего файла конфигурации:
```bash
cp config/config.default.yaml config/config.yaml
nano config/config.yaml
```
### Запуск
Чтобы запустить сервер, вы можете запустить команду Makefile:
```bash
make start
```
или вы можете запустить вручную:
```bash
go mod tidy
go build -o build/server cmd/api
./build/server
```
## Лицензия
Этот проект распространяется по [Лицензии Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).