Требования перед установкой

Настроить локальное окружение:

• Docker 20.10.21
• Docker-compose 1.26.0
• git 2.34.1

Установка проекта

Сгенерировать SSH-ключ

  ssh-keygen

Просматриваем сгенерированный ключ из файла id_rsa.pub, используя команду cat путь к файлу id_rsa.pub

  cat path

Появится ssh ключ, выделить его от ssh по = скопировать и добавить его в github. После зайти в папку, в которой будет располагаться проект выполнить команду

  git clone [email protected]:Mikuzen/SkyTest.git NameFolder

После клонирования проекта, зайти в папку проект и ввести команду

    cp .env.example .env

Скопируется файл .env.example с именем .env. Зайти в этот файл выполнить изменить строки:

    APP_DEBUG=false
    
    DB_DATABASE=Name your database 
    DB_USERNAME=Your username database
    DB_PASSWORD=Your password for user database

После этого выполняем команду docker-compose

    docker-compose up -d

Контейнеры запустили, чтобы проверить вводим команду:

    dockert ps

Заходим в контейнер skytest_app_1

docker exec -it skytest_app_1 bash

Выполняем команду composer, для загрузки зависимостей:

composer install

Выходим из контейнера введя exit

После в консоли вводим команду для создания алиаса sail:

  alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'

И выполняем команды sail:

    sail up -d
    sail artisan migrate

Роутинг проекта проекта

1. api/register - регистрация пользователя (добавляется пользователь и создается токен). Вводится name, email, password, confirm_password

2. api/login - аутентификация пользователя путем ввода email и password (создается новый токен)

3. api/logout - выход из системы (удаляется токен)

4. api/files/{folder?}- просмотр файлов авторизованного пользователя, если указан folder, отображаются только те файлы, которые находятся в указанной папке

5. api/files/store/{folder?}- загрузка файлов авторизованным пользователем, если указан folder, то файлы сохраняются сразу для указанной папки

6. api/file/rename/{file}- переименование файла пользователем

7. api/file/download/{file}- скачивание файла пользователем из системы

8. api/folder/create- создание папки с введенным title, в качестве названия

Все роуты начиная с 3 по списку доступны только, если токен существует и он совпадает с токеном авторизованного пользователя, в противном случае пользователь будет получать 401 ошибку

Postman коллекция

Коллекция для postman хранится в проекте по следующему пути: storage/collection/SkyTest.postman_collection.json

Для работы в Postman необходимо создать Environment с данными:

token - Для подстановке токена при обращении к маршрутам для работы с файлами и папками
url - адрес для обращения к api (localhost - для локального проекта, для обращения к серверу -  http://89.108.64.184)

Чтобы получить api-token для поля token в env postman обращаться по маршрутам:

{{url}/api/register - регистрация пользователя
{{url}/api/login - аутентификация пользователя