Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 1.94 KB

README.md

File metadata and controls

56 lines (33 loc) · 1.94 KB

ChatPDF Repository

Server

The server folder contains the FastAPI backend of the application.

Getting Started

  1. Navigate to the server directory: cd server
  2. Create a virtual environment: python -m venv venv
  3. Activate the virtual environment:
    • On Windows: venv\Scripts\activate
    • On macOS and Linux: source venv/bin/activate
  4. Install the required dependencies: pip install -r requirements.txt
  5. go to server/.env and type your own OPENAI Key ‼️ ‼️
  6. Run the FastAPI server: uvicorn main:app --host 0.0.0.0 --port 8000

The FastAPI server should now be running at http://localhost:8000.

Client

The client folder contains the React frontend of the application.

Getting Started

  1. Navigate to the client directory: cd client
  2. Install the dependencies: npm install
  3. Start the development server: npm start

The React development server should now be running at http://localhost:3000.

Docker Image

A Docker image of the project is available on Docker Hub:

  • Run the server Docker Hub - Server Image using this command: docker run -p 8000:8000 7soonyounes/ai-container:chatpdf-backend
  • Run the client Docker Hub - Client Image using this command: docker run -p 3000:3000 7soonyounes/ai-container:chatpdf-frontend

You can pull the image using the following command:

Usage

  1. Pull server image from docker hub.
  2. Pull client image from docker hub.
  3. Run server image from docker desktop app on port 8000.
  4. Run client image from docker desktop app on port 3000.
  5. Access app on localhost:3000.

##Youness AITHASSOUNE ##Have a GOOD DAY !!! 🚀