{"id":26187270,"url":"https://github.com/devils2ndself/unimay-backend","last_synced_at":"2026-05-01T22:33:55.111Z","repository":{"id":135987876,"uuid":"608887529","full_name":"devils2ndself/unimay-backend","owner":"devils2ndself","description":"Node.js + Express REST API server for Unimay team's website. Includes system design in Ukrainian","archived":false,"fork":false,"pushed_at":"2023-12-03T07:37:25.000Z","size":116,"stargazers_count":0,"open_issues_count":8,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-12-26T10:50:17.641Z","etag":null,"topics":["mysql","nodejs","system-design"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devils2ndself.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-03-02T23:50:21.000Z","updated_at":"2023-04-14T03:29:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"da42a8a0-cad3-4b64-a385-d10b5e158cd7","html_url":"https://github.com/devils2ndself/unimay-backend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devils2ndself/unimay-backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devils2ndself%2Funimay-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devils2ndself%2Funimay-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devils2ndself%2Funimay-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devils2ndself%2Funimay-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devils2ndself","download_url":"https://codeload.github.com/devils2ndself/unimay-backend/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devils2ndself%2Funimay-backend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32515838,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mysql","nodejs","system-design"],"created_at":"2025-03-11T23:48:57.359Z","updated_at":"2026-05-01T22:33:55.095Z","avatar_url":"https://github.com/devils2ndself.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unimay Media\n\nThis project is the backend (REST API) for the Unimay Media website.\n\n## Setting up SQL database\n\nThe server requires an SQL database for operating.\n\nMake sure you have a `.env` file in the project root directotry with MySQL database information:\n\n```\nDB_DATABASE=database\nDB_HOST=host\nDB_USER=user\nDB_PASSWORD=password\n```\n\nIf the SQL database in use is not MySQL, make sure to add the following line:\n\n```\nDB_DIALECT=postgres\n```\n\n`postgres` is an example out of these possible dialects: `mysql`, `postgres`, `sqlite`, `db2`, `mariadb`, `mssql`.\n\nBefore running the server, make sure that `database` (or schema) from `.env` exists in the database.\n\nThe server will automatically create tables on first run.\n\n### Altering tables\n\nDuring development data models could be changed; however, by default the ORM is configured not to make any changes to tables. To proceed with alteration process, add the following into `.env` and restart the server:\n\n```\nDB_ALTER_TABLES=1\n```\n\n## Downloading NPM packages\n\nRegular option:\n\n```\nnpm install\n```\n\nProduction mode:\n\n```\nnpm install --omit=dev\n```\n\n## Running the server\n\nTo run the development mode, run the following:\n\n```\nnpm run dev\n```\n\nTo run server in production mode, run the following:\n\n```\nnpm start\n```\n\n## Response\n\n### Structure\n\n-   Success\n\n    ```\n    {\n        \"status\": \"ok\",\n        \"message\": \"{{ optional, usually on status 201 }}\",\n        \"data\": {{ null / object / array }}\n    }\n    ```\n\n-   Error\n\n    ```\n    {\n        \"status\": \"error\",\n        \"error\": {\n            \"code\": {{ HTTP status code }},\n            \"message\": \"{{ meaningful error message }}\"\n        }\n    }\n    ```\n\n## Endpoints and Request structure\n\nRequests should be of type `multipart/form-data` (or JavaScript's `FormData`).\n\n**See /docs endpoint for Swagger UI with info on operations and request/response schemas**\n\n# System Design (in Ukrainian)\n\n## Опис проєкту\n\nСайт виступає візиткою команди Unimay Media, яка дає можливість ознайомитись з проєктами команди, її членами, та знайти інформацію з приводу партнерства/фідбеку.\n\n## Функціональні вимоги - що система робить\n\n-   Вебсайт мусить мати секцію з проєктами команди\n    -   Інформація та медіа проєктів додаються/оновлюються/видаляються модераторами\n    -   Система має підтримувати пошук проєктів за назвою та навігацію по проєктах за жанром/типом\n    -   Кожен проєкт мусить мати медіа-плеєр у форматі HTML, який буде вставлено безпосередньо у сторінку під час генерації, та графічне зображення\n-   Вебсайт повинен мати секцію з інформацією про команду та її учасників\n    -   Записи про учасників команди мусять мати графічне зображення та опцію редагування, додавання та видалення інформації\n    -   Контактна інформація команди мусить мати опцію редаугвання, наряду з посиланнями та описом\n-   На вебсайті має бути секція \"Послуги\" з інформацією про комерційну діяльність або партнерство\n    -   Опис/ціна послуг можуть бути змінені модератором\n-   Система мусить мати Систему Керування Контентом, можливість користування якою є тільки у авторизованих користувачів\n\n## Нефункціональні вимоги - якою повинна бути система\n\n-   Проєкт має бути у форматі вебсайту, доступного, як з ПК, так і з мобільного пристрою\n-   Контент і написи вебсайту повинні бути українською мовою\n-   Усі відео та аудіо-матеріали показані на сайті мають бути взяті з ресурсів у інтернеті у відкритому доступі\n-   Сумарний обсяг бази даних не повинен перевищувати 1.8 гігабайтів.\n\n## Масштаб проєкту\n\nВебсайт служить місцем для знаходження медіа у озвучці команди та інформації про команду.\n\n-   Відвідувачі зможуть дивитися медіа у озвучці команди на сайті\n-   Потенційні партнери/клієнти зможуть знайти усю інформацію про послуги та контактні дані команди\n\nМасштаб проєкту не включає в себе функціонал для перемов або безпосередньої купівлі/продажу послуг, але надає контактні дані для з'єднання з командою.\n\nКоманда повинна буде регулювати контент вручну, і тільки вона відповідальна за те, що тільки необхідний контент поститься на вебсайті.\n\n## Потенційні проблеми та ризики\n\n-   Можливість реєстрації/логіну для звийчайних користувачів?\n-   Обмеженність медіа-контенту плеєрами з підтримкою вставлення як `\u003ciframe\u003e`\n-   Збереження графічних зображень для тайтлів та фотографій учасників - де і як?\n\n## Технології які будуть використані\n\n-   Technologies\n    -   Front-end: React on Vite\n    -   Back-end: Express.js\n    -   DB: MySQL\n-   Hosting\n    -   Front-end: TBD (plan: [ukraine.com.ua](https://www.ukraine.com.ua/uk/))\n    -   Back-end: AWS EC2 - t3.nano/t3.micro\n    -   DB: front-end hosting\n\n## Бюджет (у USD)\n\n_2022/04/13_  \n1 USD ($) ~ 37 UAH (₴)\n\n-   Front-end + MySQL: ₴2100/year ~ $56/year\n-   Domain: ₴600-1000 ~ $15-25\n-   Back-end - AWS EC2: ~$35/year\n\nУсього: ~$100-120/year\n\n## Дизайн бази даних\n\n![image](https://github.com/devils2ndself/unimay-backend/assets/71770433/d1535f25-7f0e-4d1e-ae36-e34ab7836e3f)\n\n## [Архітектура](https://lucid.app/lucidchart/a0421e16-3de9-40a8-bfce-df7b7dd06143/edit?viewport_loc=-128%2C6%2C2016%2C968%2C0_0\u0026invitationId=inv_03b17de1-7521-4256-883e-050b2b2b2d2a)\n\n![image](https://github.com/devils2ndself/unimay-backend/assets/71770433/c485a921-0e1b-41d7-b9fe-6b14593b1777)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevils2ndself%2Funimay-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevils2ndself%2Funimay-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevils2ndself%2Funimay-backend/lists"}