diff --git a/README.md b/README.md index 893f15d..0557791 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,30 @@ -# Getting Started with Fastify-CLI [Fastify-CLI](https://www.npmjs.com/package/fastify-cli) -This project was bootstrapped with Fastify-CLI. +# fastify-rest-api -## Available Scripts +Учебный REST API на [Fastify](https://fastify.dev/), отдающий выдуманные данные. -In the project directory, you can run: +## Зачем это нужно -### `npm run dev` +Тестировщику и фронтендеру нужен API, который можно поднять за одну команду и +дёргать как угодно: он ничего не хранит, ничего не ломает и на каждый запрос +отдаёт правдоподобные данные. Их генерирует [faker](https://fakerjs.dev/), +поэтому база не нужна вовсе. -To start the app in dev mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +Подходит как заглушка для тренировки запросов, написания автотестов на API и +демонстрации структуры проекта на Fastify: плагины в `plugins/`, маршруты в +`routes/`, автозагрузка через fastify-cli. -### `npm start` +## Запуск -For production mode +```bash +make install +make dev # http://localhost:3000, с перезапуском на изменения +make test +``` -### `npm run test` +--- -Run the test cases. +[![Hexlet Ltd. logo](https://raw.githubusercontent.com/Hexlet/assets/master/images/hexlet_logo128.png)](https://hexlet.io/?utm_source=github&utm_medium=link&utm_campaign=fastify-rest-api) -## Learn More - -To learn Fastify, check out the [Fastify documentation](https://www.fastify.io/docs/latest/). - -[![Hexlet Ltd. logo](https://raw.githubusercontent.com/Hexlet/assets/master/images/hexlet_logo128.png)](https://hexlet.io?utm_source=github&utm_medium=link&utm_campaign=fastify-rest-api) - -This repository is created and maintained by the team and the community of Hexlet, an educational project. [Read more about Hexlet](https://hexlet.io?utm_source=github&utm_medium=link&utm_campaign=fastify-rest-api). +This repository is created and maintained by the team and the community of Hexlet, an educational project. [Read more about Hexlet](https://hexlet.io/?utm_source=github&utm_medium=link&utm_campaign=fastify-rest-api). See most active contributors on [hexlet-friends](https://friends.hexlet.io/).