vladislav-cheremisin / graphql-basics Goto Github PK

1. Установите LTS версию NodeJS с официального сайта.
2. Перейдите по ссылке и следуя инструкциям установите и запустите mongoDB и микросервисы необходимые для работы приложения.
3. Скачайте файлы приложения нажав на кнопку Code в правом верхнем углу репозитория и выбрав из контекстного меню удобный для вас способ загрузки.
4. Распакуйте файлы приложения на локальном диске своего устройства.
5. Откройте папку с файлами приложения используя редактор кода (например VSCode) или консоль.
6. Выполните в консоли команду npm install для того чтобы установить все необходимые пакеты.

Приложение имеет следующие консольные команды позволяющие произвести запуск:

• npm run start - Запустить приложение.
• npm run start:dev - Запустить приложение в режиме разработки (с использованием Nodemon).

После запуска приложения необходимо открыть его в браузере (по умолчанию http://localhost:4000) и нажать на кнопку Query your server.

Ссылки и порты используемые по умолчанию для работы приложения и микросервисов содержатся в файле .env, вы можете отредактировать их при необходимости.

Приложение отлично работает с микросервисами по ссылке выше. Если вы используете уже заполненную базу данных, то крайне желательно удалить из нее id ведущие к несуществующим объектам, если таковые имеются (может вызвать проблемы в работе Favorites запросов, так как по умолчанию этот микросервис не имеет валидации входных параметров). В случае возникновения каких-либо проблем в работе приложения с удовольствием помогу решить их если вы свяжитесь со мной по любому из контактов ниже.

Для того чтобы использовать все доступные в приложении запросы необходимо выполнить регистрацию и авторизацию. Для этого имеются следующие запросы:

Запрос для регистрации:

• register(firtName: String, lastName: String, email: String, password: String)

Запрос для авторизации:

• jwt(email: String, password: String)

Также можно получить данные о имеющемся в базе пользователе используя уникальный идентификатор:

• user(id: String)

После успешной авторизации можно использовать все доступные в приложении запросы. Типы данных для аргументов отображаются в приложении. Везде где имеется тип данных ID используйте строку с уникальным идентификатором.

Queries:

• artist
• artists

Mutations:

• createArtist
• deleteArtist
• updateArtist

Queries:

• genre
• genres

Mutations:

• createGenre
• deleteGenre
• updateGenre

Queries:

• track
• tracks

Mutations:

• createTrack
• deleteTrack
• updateTrack

Queries:

• band
• bands

Mutations:

• createBand
• deleteBand
• updateBand

Queries:

• album
• albums

Mutations:

• createAlbum
• deleteAlbum
• updateAlbum

Queries:

• favourites

Mutations:

• addTrackToFavourites
• addBandToFavourites
• addArtistToFavourites
• addGenreToFavourites

• typescript
• ts-node
• nodemon
• apollo
• axios
• dotenv
• graphql
• graphql-tools

В случае необходимости получения дополнительной информации, и/или каких либо разъяснений по логике работы приложения можете связаться со мной:

• Discord: ch1rik#2995
• Email: [email protected]

Приятного пользования!