{"repo":"ti-broish/api","free":true,"listed":false,"github":"https://github.com/ti-broish/api","clone":"git clone https://github.com/ti-broish/api.git","description":"Ти Броиш API","language":"TypeScript","stars":40,"topics":["typescript","javascript","nestjs","api","postgresql","rest-api","firebase-auth","firebase-cloud-messaging","docker"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Ти Броиш REST API Ти Броиш е платформа за паралелно преброяване и проследяване на парламентарните избори в България. Това е REST API приложението, което приема и обработва данните от мобилните приложения. Първоначална инсталация Пуснете [Docker][], включете [Docker Compose 2.0][] и изпълнете следните команди: Конфигурация .env.schema файлът съдържа стойности по подразбиране и всички възможни настройки на средата, които приложението приема. Коригирайте всичко, което е нужно да промените в .env . Свалете Service account JSON файл от Firebase и го запазете като firebase.json в проекта. Генериране на Firebase JWT Token Ако искате лесно да генерирате JWT токен за автентикация с Firebase, създайте потребител във Firebase Console и попълнете в .env : - FIREBASE API KEY - FIREBASE UID След това можете лесно да генерирате ключ със следната команда: Работа с ReCAPTCHA Регистрирайте приложението си за ReCAPTCHA като следвате стъпките описани тук. При локално стартирано приложение трябва да закоментирате следния ред skipIf: process.env.NODE ENV !== 'production', в app.ts . Стартиране API Документация Ти Броиш REST API- използва Swagger OpenAPI стандарта. След като стартирате приложението можете да намерите API документация на: - http://localhost:4000/docs - Swagger документация и playground - http://localhost:4000/docs-json - OpenAPI JSON Спецификация Разработване Тестове Контакти - team@tibroish.bg Лиценз Кодът на Ти Броиш е лицензиран под MIT лиценз. [docker]: https://www.docker.com/pr","default_branch":null,"files":null,"tree":[],"storefront":"/r/ti-broish","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ti-broish/api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}