/hw1-se-school_2022-code-review-Valentine-456

hw1-se-school_2022-code-review-Valentine-456 created by GitHub Classroom

Primary LanguageTypeScript

GSES BTC Application

Технічне завдання та опис API тут

Цей проект був завантажений за допомогою Fastify-CLI.

Цей проект був побудований з Fastify та TypeScript.

Docker

Припустимо що ви перебуваєте в корені проекту, для запуску проекту, запустіть наступне у вашому терміналі:

$ docker build -t fastify_gses_btc_app .
$ docker run -p 5000:5000 fastify_gses_btc_app

Важливо: Потрібно обов'язково указувати параметр -p 5000:5000 щоб API ендпоінтами можна було користуватися.

Важливо: В рамках відбору до Genesis Software Engineer School, щоб передати необхідні настройки для запуску проекту в Docker (що є умовою конкурсу), мені довелось закомітити .env файл (що є неприпустимо в звичайних ситуаціях). В можливому майбутньому розвитку цього пет-проекту, я зміню env змінні.

Available Scripts

В директорії проекту можна запускати:

npm run start

Запускає попередньо скомпільований проект у JS у папці /dist/ в production mode.

npm run start:ts

Компілює і запускає сервер в production mode.

npm run build

Компілює проект в JS

npm run watch:ts

Компілює проект в JS у watch mode.

npm run dev

Запускає проєкт в development mode (в watch mode).

npm run dev:start

Запускає проєкт в development mode (без watch mode).

npm run lint

Форматує код та запускає лінтер.

npm run test:unit

Запускає unit тести.

npm run test:integration

Запускає integration тести.

npm run test:e2e

Запускає e2e тести стороннього сервісу.

Запустіть http://localhost:5000 щоб побачити чи протестувати

Learn More

To learn Fastify, check out the Fastify documentation.