https://github.com/pinsaraperera/intellihack_backend
This is the backend of viewMo AI cloud platform. AI base graph generation engine, Agent base simulations, Protected endpoints with JWT token authentication and many more features included.
https://github.com/pinsaraperera/intellihack_backend
ai-graphs fastapi file-upload gcp jwt-authentication langchain logging redis-cache text-su vector-database
Last synced: 9 months ago
JSON representation
This is the backend of viewMo AI cloud platform. AI base graph generation engine, Agent base simulations, Protected endpoints with JWT token authentication and many more features included.
- Host: GitHub
- URL: https://github.com/pinsaraperera/intellihack_backend
- Owner: PinsaraPerera
- License: apache-2.0
- Created: 2024-06-18T08:04:25.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T13:12:03.000Z (almost 2 years ago)
- Last Synced: 2024-07-08T16:23:03.475Z (almost 2 years ago)
- Topics: ai-graphs, fastapi, file-upload, gcp, jwt-authentication, langchain, logging, redis-cache, text-su, vector-database
- Language: Python
- Homepage:
- Size: 129 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Intellihack ViewMo backend
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Running the Application](#running-the-application)
- [API Documentation](#api-documentation)
- [Project Structure](#project-structure)
- [License](#license)
## Introduction
This is a backend project built with FastAPI. The project provides several routing paths to handle different functionalities. FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
## Features
- Fast and asynchronous API endpoints.
- Detailed API documentation with Swagger UI and Redoc.
- Easy to extend and customize.
- Uses Pydantic for data validation.
## Installation
### Prerequisites
- Python 3.6+
- `pip` (Python package installer)
### Steps
1. Clone the repository:
```bash
git clone https://github.com/PinsaraPerera/intellihack_backend.git
cd your-repo-name
```
2. Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. Install the dependencies:
```bash
pip install -r requirements.txt
```
## Configuration
Create a `.env` file in the root directory and add your environment variables. Example:
```bash
PROJECT_ID = ""
REGION = ""
INSTANCE_NAME = ""
INSTANCE_CONNECTION_NAME = f"{PROJECT_ID}:{REGION}:{INSTANCE_NAME}"
DB_USER = ""
DB_PASS = ""
DB_NAME = ""
PRIVATE_IP =
OPENAI_API_KEY = ""
BUCKET_NAME = ""
# redis configure
REDIS_HOST = ""
REDIS_PORT =
# microservices url
AGENT_SERVICE_URL = ""
```
## Running the Application
To run the application, execute the following command:
```bash
uvicorn app.main:app --host 0.0.0.0 --port 80 --reload
```
This will start the server at http://127.0.0.1:80
API Documentation
FastAPI automatically generates interactive API documentation at the following URLs:
Swagger UI: http://127.0.0.1:80/docs
Redoc: http://127.0.0.1:80/redoc
## Project Structure
```bash
intellihack_backend/
├── .github/
│ └── workflows/
│ └── (workflow files)
├── app/
│ ├── api/
│ │ ├── endpoints/
│ │ │ ├── init.py
│ │ │ ├── authentication.py
│ │ │ ├── gcp.py
│ │ │ ├── query.py
│ │ │ ├── train.py
│ │ │ └── users.py
│ ├── core/
│ ├── crud/
│ ├── db/
│ ├── models/
│ ├── quizGeneratingAgent/
│ ├── schemas/
│ ├── utils/
│ ├── init.py
│ └── main.py
├── .dockerignore
├── .gitignore
├── Dockerfile
├── Dockerfile.redis
├── LICENSE
├── README.md
├── dependencies.txt
├── entrypoint.sh
├── logging_config.py
├── redis.conf
├── requirements.txt
└── template.py
```
## License
This project is licensed under the Apache License. See the LICENSE file for more details.