Giter Club home page Giter Club logo

yalms's Introduction

Yalms

Простой сервер с оркестратором и агентами, могут решать простые арифметические задачи со скобками

схема апи

Требования

docker и docker compose - если вы на linux

apt install docker docker-compose

или запущенный docker desktop

так же потребуется insomnia для отправки запросов, она бесплатна и конфиг с роутами прикреплён к гиту

Как запустить?

Зайдите в dotenv и измените параметры.

После этого в главной папке проекта запустите compose

docker compose up -d

Как использовать?

Если вы не зарегистрированы

  1. Зайдите в insomnia
  2. Нажмите use local scratch pad внизу логина
  3. Найдите слева сверху плашку c названием scratch pad
  4. import -> выбираем файл insomia.json -> scan -> import
  5. Выбираем любой роут и делаем реквесты через send
  6. если нужна информация выбирам в роуте вкладку docs
  7. данные для отправки реквеста меняем во вкладке json

Если вы зарегистрированы

  1. Зайдите в insomnia
  2. Входите в аккаунт
  3. Найдите слева снизу плашку c названием documents
  4. по центру выбираем import -> выбираем файл insomia.json -> scan -> import
  5. Выбираем любой роут и делаем реквесты через send
  6. если нужна информация выбирам в роуте вкладку docs
  7. данные для отправки реквеста меняем во вкладке json

yalms's People

Contributors

ultard avatar

Stargazers

Яков Новашинский avatar Sergey Dmitriev avatar LevPrav avatar Ilia Zaraysky avatar

Watchers

 avatar

yalms's Issues

Результаты проверки

Пройдемся по критериям:

0 Необходимые требования:
- Существует Readme документ, в котором описано, как запустить систему и как ей пользоваться.
- Это может быть docker-compose, makefile, подробная инструкция - на ваш вкус
- Если вы предоставляете только http-api, то
- в Readme описаны примеры запросов с помощью curl-a или любым дргуми понятными образом
- примеры полны и понятно как их запустить
Этот пункт дает 10 баллов. Без наличия такого файла - решение не проверяется.

  • Ридми существует, инструкции адекватные +10

1 Программа запускается и все примеры с вычислением арифметических выражений корректно работают - 10 баллов

  • Примеры запускаются корректно +10

2 Программа запускается и выполняются произвольные примеры с вычислением арифметических выражений - 10 баллов

  • Да, только операция деления на ноль работает некорректно +7:
{
	"ID": "a61ebfa0-ae4b-4943-b066-1f8fcd45ab87",
	"Expression": "(10+25)/(16-8-8)",
	"Status": "Completed",
	"Tokens": null,
	"Result": 3,
	"CreatedAt": "2024-02-22T09:30:01.94676Z",
	"ProcessAt": "2024-02-22T09:30:41.321933Z",
	"CompletedAt": null
}
{
	"ID": "060fecb9-e4f4-47b8-9393-423608a10ce8",
	"Expression": "12/0",
	"Status": "In progress",
	"Tokens": [
		"12",
		"0",
		"/"
	],
	"Result": null,
	"CreatedAt": "2024-02-22T09:33:24.487847Z",
	"ProcessAt": "2024-02-22T09:33:25.478482Z", //при таймауте 0 на операцию ответ совсем не приходит
	"CompletedAt": null
}

3 Можно перезапустить любой компонент системы и система корректно обработает перезапуск (результаты сохранены, система продолжает работать) - 10 баллов

  • Корректно обрабатывается перезапуск системы +10

4 Система предосталяет графический интерфейс для вычисления арифметических выражений - 10 баллов

  • Нет, но json формат тоже приятен для глаз +5

5 Реализован мониторинг воркеров - 20 баллов

  • Нет, но за саму реализацию воркеров и получения их кол-ва через переменную окружения +5

6 Реализован интерфейс для мориторинга воркеров - 10 баллов

  • Нет +0

7 Вам понятна кодовая база и структура проекта - 10 баллов (это субъективный критерий, но чем проще ваше решение - тем лучше).
Проверяющий в этом пункте честно отвечает на вопрос: "Смогу я сделать пулл-реквест в проект без нервного срыва"

  • Написано максимально легко, понятно все и пулл-реквест делается без нервотрепок +10

8 У системы есть документация со схемами, которая наглядно отвечает на вопрос: "Как это все работает" - 10 баллов

  • Схема есть, достаточно понятная +10
  1. Выражение должно иметь возможность выполняться разными агентами - 10 баллов
  • Реализован только один агент с несколькими воркерами +5

Проект мне очень понравился и особенно прикручение insomnia. В проекте подключены postgresql, docker и внешние фреймворки. Проверять удобно, организация кода понравилась.

  • Бонусные баллы +18

Итоговая оценка проекта: 90/110

  • P.S Балл не будет выставлен до дедлайна проверок, так что если Вы решили что-то изменить и/или добавить, то запрашивайте перепроверку в тг: @duskchancellor

Делаю проверку вашей работы

День добрый.
В настоящее время делаю проверку вашей работы согласно вашему readme. Сервис не запускается, при запуске выдается ошибка:
2024/02/20 17:27:34 /home/keiz/Yandex/ultard/Yalms/api/main.go:55
[error] failed to initialize database, got error failed to connect to host=localhost user=postgres database=yalms: dial error (dial tcp 127.0.0.1:5432: connect: connection refused)
2024/02/20 17:27:34 Error connecting to database: failed to connect to host=localhost user=postgres database=yalms: dial error (dial tcp 127.0.0.1:5432: connect: connection refused)
exit status 1

Соответственно, либо вы дополните readme подробной инструкцией, как мне запустить ваш проект, чтобы он работал на моем компьютере (моя система ubuntu 18.04), либо я, к сожалению, буду вынуждена поставить вам соответствующую оценку.

С глубоким к вам уважением, Анастасия.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.