GenZ AI Smart Lead

Welcome to the GenZ AI Smart Lead repository. This project leverages FastAPI to provide a smart lead management solution.

Getting Started

Follow these instructions to set up and run the application on your local machine.

Prerequisites

Ensure you have the following installed:

• git
• Python >= 3.8
• pip3
• virtualenv

Installation

1. Clone the Repository

   git clone https://github.com/aaziz9/genz_ai_smart_lead.git

2. Navigate to the develop Branch

   cd genz_ai_smart_lead
   git checkout develop
   

3. Create a Virtual Environment (Linux)

    virtualenv venv
    source venv/bin/activate

4. Install the dependencies

   pip install -r requirements.txt

5. Run the server application

   fastapi dev main_app.py

Once the application is running, you can test the API in your browser by navigating to:

http://127.0.0.1:8000/docs

This will open the interactive API documentation provided by FastAPI, where you can explore and test the endpoints.

Contributing

If you would like to contribute to this project, please fork the repository and create a pull request with your changes. Ensure that you follow the code of conduct and adhere to the contribution guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.