stradivario/api

Ти Броиш API

Ти Броиш REST API

Ти Броиш е платформа за паралелно преброяване и проследяване на парламентарните избори в България.

Това е REST API приложението, което приема и обработва данните от мобилните приложения.

Първоначална инсталация

Пуснете Docker и изпълнете следните команди:

# Clone the project
git clone [email protected]:Da-Bulgaria/ti-broish-api.git
cd ti-broish-api
# Install dependencies
npm install
# Start the database with Docker
npm run start:dev:db
# Build and start the app
npm run start
# Create the schema and seed the data
npm run migration:run && npm run seed:run

Конфигурация

Свалете Service account JSON файл от Firebase и го запазете като firebase.json в проекта.

# Copy the environment configuration template
cp .env.schema .env

.env файлът съдържа стойности по подразбиране от шаблона.

Генериране на Firebase JWT Token

Ако искате лесно да генерирате JWT токен за автентикация с Firebase, създайте потребител във Firebase Console и попълнете в .env:

• FIREBASE_API_KEY
• FIREBASE_UID

След това можете лесно да генерирате ключ със следната команда:

npm run firebase:token

Стартиране

npm run start

API Документация

Ти Броиш REST API- използва Swagger OpenAPI стандарта. След като стартирате приложението можете да намерите API документация на:

• http://localhost:4000/docs - Swagger документация и playground
• http://localhost:4000/docs-json - OpenAPI JSON Спецификация

Разработване

# watch mode
npm run start:dev

Тестове

# unit tests
npm run test

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov

Контакти

• [email protected]

Лиценз

Кодът на Ти Броиш е лицензиран под MIT лиценз.