ai_tools

A RESTful API for managing AI tools, categories, and user favorites.

Overview

ai_tools is a FastAPI-based RESTful API designed to help users discover, categorize, and manage their favorite AI tools. It provides endpoints for CRUD operations on tools and categories, as well as features for users to bookmark or favorite tools for quick access.

Features

• CRUD operations for AI tools
• Organize tools into categories
• User authentication (if implemented)
• Manage user favorite/bookmarked tools
• RESTful API design

Tech Stack

• Backend Framework: FastAPI
• Database Migration: Alembic
• Server: Uvicorn
• Language: Python (97.6%)
• Templating: Mako (1.8%)
• Shell scripts: (0.6%)

Getting Started

Prerequisites

• Python 3.8+
• pip

Installation

1. Clone the repository:

   git clone https://github.com/AdnanNasr/ai_tools.git
   cd ai_tools

2. (Optional) Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate   # On Windows: venv\Scripts\activate

3. Install dependencies:

   pip install -r requirements.txt

4. Run database migrations (if applicable):

   alembic upgrade head

Usage

Start the API server with Uvicorn:

uvicorn app.main:app --reload

By default, the API will be available at http://localhost:8000/.

API Endpoints

• /tools – List, create, update, or delete AI tools
• /categories – Manage categories for AI tools
• /favorites – Manage user favorites/bookmarks

For detailed API documentation, access the built-in Swagger docs at http://localhost:8000/docs when the server is running.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

License

This project is currently unlicensed.

Contact

Maintained by AdnanNasr.