https://github.com/stynw7/ablework-ai
FindIT Hackathon 2025 - AI Repository - Team Overclock
https://github.com/stynw7/ablework-ai
ai ai-review-site flask python3 recommendation-system
Last synced: about 1 month ago
JSON representation
FindIT Hackathon 2025 - AI Repository - Team Overclock
- Host: GitHub
- URL: https://github.com/stynw7/ablework-ai
- Owner: StyNW7
- Created: 2025-03-24T09:28:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-14T15:22:20.000Z (about 1 year ago)
- Last Synced: 2025-05-07T19:57:28.888Z (about 1 year ago)
- Topics: ai, ai-review-site, flask, python3, recommendation-system
- Language: Python
- Homepage: https://ablework-ai-production.up.railway.app/
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AbleWork - AI Repository
This repository contains the AI-related code for the AbleWork application.
## Prerequisites
Before setting up the project, make sure you have the following tools and software installed:
- **Python 3.x** (recommended: Python 3.8 or higher)
- **pip** (Python package installer)
## Installation
Follow these steps to set up the AI components locally:
### 1. **Set Up Python Virtual Environment**:
To ensure the project runs with the correct dependencies, it is recommended to use a virtual environment. Follow these steps:
- Create a virtual environment:
```bash
python -m venv venv
```
- Activate the virtual environment:
On Windows:
```bash
venv\Scripts\activate
```
On macOS/Linux:
```bash
source venv/bin/activate
```
### 2. **Install Python Dependencies**:
Once the virtual environment is activated, you can install the required Python dependencies.
- Using `requirements.txt`:
```bash
pip install -r requirements.txt
```
- Alternatively, you can install the dependencies manually:
```bash
pip install flask
pip install flask-cors
pip install pymupdf
pip install scikit-learn
pip install huggingface_hub
pip install python-dotenv
```
### 3. **Set Up Environment Variables**:
Create a `.env` file in the root directory to store sensitive information like your Hugging Face API key and other configuration details.
Example `.env` file:
```ini
HF_API_KEY=your_huggingface_api_key_here
```
Replace the placeholder with your Hugging Face API key.
### 4. **Start the AI Server**:
Once the dependencies are installed and the `.env` file is set up, you can start the AI server by running the following:
```bash
python main.py
```
By default, the server will be running on `http://localhost:5000`.
### 5. **Deactivate Virtual Environment**:
After finishing your work, you can deactivate the virtual environment by running:
```bash
deactivate
```