https://github.com/excellent-84/crud_typeorm

Last synced: over 1 year ago
JSON representation

README

## «CRUD TypeORM»

### Описание проекта:

CRUD по взаимодействию с пользователями и реляционной базой данных PostgreSQL по средствам платформы TypeORM и фреймворка Express.

### Стек технологий:

### Как запустить проект:

##### Клонировать репозиторий и перейти в него в командной строке:

```bash
$ git clone https://github.com/Excellent-84/crud_typeorm.git
$ cd crud_typeorm
```

##### Создать файл .env и указать необходимые токены по примеру .env.example:
```bash
$ touch .env
```

##### Установить зависимости:

```bash
$ npm install
```

##### Запустить проект:

```bash
$ npm run start
```

### Примеры запросов к API с помощью Postman:

##### Добавление пользователя в базу данных:

Во вкладке Body выбрать x-www-form-urlencoded.
В поле key указать name и age.
В поле value указать их значения.

Метод POST к эндпоинту http://127.0.0.1:3000/users

Пример ответа:

```bash
{
"id": 21,
"name": "John",
"age": 30
}
```

##### Получение списка пользователей:

Метод GET к эндпоинту http://127.0.0.1:3000/users

Пример ответа:

```bash
[
{
"id": 1,
"name": "John",
"age": 30
},
{
"id": 2,
"name": "Jane",
"age": 25
},
...
]
```

##### Получение пользователя по 'id':

Метод GET к эндпоинту http://127.0.0.1:3000/users/13

Пример ответа:

```bash
{
"id": 13,
"name": "John",
"age": 30
}
```

##### Обновление данных пользователя:

Во вкладке Body выбрать x-www-form-urlencoded.
В поле key указать name и age.
В поле value указать их новые значения.

Метод PUT к эндпоинту http://127.0.0.1:3000/users/21

Пример ответа:

```bash
{
"id": 21,
"name": "John Doe",
"age": 30
}
```

##### Удаление пользователя из базы данных:

Метод DELETE к эндпоинту http://127.0.0.1:3000/users/13

#### Автор: [Горин Евгений](https://github.com/Excellent-84)