Skip to content

docs: explain the repository instead of describing the scaffold #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mokevnin merged 1 commit into from
Aug 12, 2026
Merged

docs: explain the repository instead of describing the scaffold #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/).