Skip to content

Commit b8d5a15

Browse files
CopilotDevanshuSave
andcommitted
Add README.md with project description and setup instructions
Co-authored-by: DevanshuSave <1951745+DevanshuSave@users.noreply.github.com>
1 parent 64699bd commit b8d5a15

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# FastAPI Project with Ollama Integration
2+
3+
## Description
4+
A FastAPI project demonstrating integration with Ollama, an open-source lightweight large language model (LLM) runtime. This application allows you to interact with Ollama models via FastAPI endpoints, making it easy to build AI-powered APIs.
5+
6+
## Setup Instructions
7+
8+
### Prerequisites
9+
- Python 3.8 or higher
10+
- <a href="https://ollama.ai/">Ollama</a> installed locally
11+
12+
### 1. Clone the Repository
13+
```bash
14+
git clone https://github.com/DevanshuSave/FastAPI.git
15+
cd FastAPI
16+
```
17+
18+
### 2. Install Python Dependencies
19+
```bash
20+
pip install -r requirements.txt
21+
```
22+
23+
### 3. Install and Run Ollama
24+
Follow the official Ollama installation guide for your OS from <a href="https://ollama.ai/download">https://ollama.ai/download</a>
25+
26+
Start Ollama on your local machine:
27+
```bash
28+
ollama serve
29+
```
30+
31+
### 4. Run the FastAPI Application
32+
```bash
33+
uvicorn main:app --reload
34+
```
35+
36+
The FastAPI app will be available at http://127.0.0.1:8000.
37+
38+
### 5. Test the API
39+
Open your browser and navigate to http://127.0.0.1:8000/docs to access the interactive API documentation and try out endpoints.
40+
41+
---
42+
43+
Feel free to update this README with additional integration, usage, and deployment details as your project evolves.

0 commit comments

Comments
 (0)