AI talkingdocs

Project Readme: ReactJs с виктором Framework, MongoDB, JWT, Node.js и многое другое

Оглавление

1. Введение
2. Технологии используются
3. Настройка и конфигурация
4. Структура проекта
5. Аутентификация и разрешение
6. Хранилище данных
7. Загрузка файла
8. Фронт и пользовательский интерфейс
9. API конечные точки

Введение

Мой проект представляет собой приложение PDFCHAT, созданное с использованием REACTJS VITE Framework, MongoDB для хранения данных, JWT для аутентификации и авторизации пользователя, а также Node.js с Express.js для бэкэнда. Он также использует различные библиотеки и инструменты для эффективной разработки, в том числе DOTENV для управления переменными окружающей среды, Langchain и его векторный хранилище для обработки языка, Multer для загрузки файлов и Axios для выполнения запросов на бэкэнд. Проект стилизован с помощью CSS и Shadcn Framework для изящного пользовательского интерфейса.

На заднем плане я использовал node.js с Express.js для обработки запросов и MongoDB для хранения информации пользователя и управления входами в пользователя. Чтобы обеспечить безопасность, я использовал JSON Web токены для аутентификации пользователей, чтобы убедиться, что только авторизованные пользователи могут получить доступ к определенным частям проекта.

Для обработки файлов PDF я использовал инструмент под названием Multer для хранения файлов и их местоположений в базе данных. Затем я обработал загруженные PDF -файлы, разбивая их на более мелкие детали и сохраняя их в векторном магазине HNSW, предоставленном Langchain. Это путешествие расширило мои навыки и дало мне лучшее понимание возможностей, предлагаемых передовыми технологиями, такими как Langchain и Rag.

Технологии используются

• ReactJS : популярная библиотека JavaScript для создания пользовательских интерфейсов.
• Vite Framework : инструмент Fast Build Intool и Development Server для современной веб -разработки.
• MongoDB : база данных NOSQL для хранения информации пользователя.
• JWT (JSON IB TOKENS) : Используется для безопасной аутентификации и авторизации.
• Node.js : время выполнения JavaScript для построения бэкэнда.
• Express.js : минимальная и гибкая структура приложения Node.js для обработки маршрутов.
• DOTENV : Для управления переменными среды, включая ключи API OpenAI, учетные данные MongoDB Atlas и секреты JWT.
• Langchain : для языковой обработки и анализа текста.
• Multer : промежуточное программное обеспечение для обработки загрузки файлов.
• Axios : HTTP-клиент, основанный на обещаниях, о выполнении запросов на бэкэнд.
• Tailwind CSS : утилита CSS-структура для стилизации фронта.
• Shadcn Framework : для улучшения пользовательского интерфейса с помощью теней и эффектов.

Настройка и конфигурация

Перед запуском проекта необходимо настроить переменные среды и конфигурации:

1. Клонировать репозиторий : начните с клонирования этого репозитория в локальную машину.

2. Настройка фронта :

   • Перейдите к каталогу Frontend и запустите npm install для установки зависимостей Frontend.
   • Используйте npm run dev , чтобы запустить Frontend.

3. Настройка бэкэнд :

   • Перейдите в сертификационный каталог и запустите npm install для установки зависимостей.
   • Создайте файл .env в каталоге Бэкэнд и установите следующие переменные:
     • PORT : номер порта на сервере будет работать. (По умолчанию 8080)
     • username : Mongodb Atlas Connection имя пользователя.
     • password : пароль MongoDB Atlas Connection.
     • JWT_SECRET : секрет генерации токенов JWT.
     • OPENAI_API_KEY : openai api -ключ.

4. Настройка базы данных :

   • Настройте базу данных MongoDB, используя предоставление собственных учетных данных в Dotenv.

5. Начните бэкэнд :

   • Запустите npm start запустить бэкэнд -сервер.

6. Доступ к приложению :

   • Посетите http://localhost:5173 в браузере, чтобы получить доступ к приложению.
   • Откройте по умолчанию http://localhost:8080 или http://localhost:PORT в вашем терминале, чтобы получить доступ к приложению бэкэнд.

Структура проекта

Структура проекта организована в два основных каталога:

• frontend : содержит весь код ReactJS для фронта с TypeScript.
• backend : содержит сервер node.js с использованием express.js для логики бэкэнд.

Аутентификация и разрешение

Я использовал JWT (JSON Web Tokens) для аутентификации пользователей и авторизации. Когда пользователи регистрируются или входят в систему, они получают токен, который должен быть отправлен с последующими запросами на доступ к авторизованным маршрутам.

Хранилище данных

Пользовательская информация хранится в MongoDB, гибкой базе данных NOSQL. Пользовательские данные надежно хранятся и извлекаются по мере необходимости для взаимодействия с пользователем.

Загрузка файла

Я использовал Multer, промежуточное программное обеспечение для обработки загрузки файлов, позволяя пользователям загружать такие файлы, как изображения или документы. Эта функция улучшает пользовательский опыт, поддерживая мультимедийный контент.

Фронт и пользовательский интерфейс

Frontend разработан с удобным интерфейсом с использованием Tailwind CSS и Framework Shadcn. Он предлагает отзывчивый и визуально привлекательный опыт для пользователей.

API конечные точки

Бэкэнд предоставляет различные конечные точки API для управления пользовательскими данными, аутентификацией и загрузки файлов. Эти конечные точки задокументированы в коде, и вы можете найти более подробную информацию в кодовой базе бэкэнда.