Spaces:
Sleeping
Sleeping
File size: 3,088 Bytes
a532053 1b4d194 a532053 1b4d194 a532053 1b4d194 a532053 13904c3 a532053 13904c3 a532053 13904c3 a532053 1b4d194 a532053 13904c3 a532053 1b4d194 a532053 13904c3 a532053 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | ---
title: Expressly
emoji: 🛠️
colorFrom: blue
colorTo: purple
sdk: docker
app_port: 7860
license: mit
short_description: Expressly - Text Transformation App
---
# Expressly - Text Transformation App Backend
This document provides an overview of the backend server for the Expressly - Text Transformation App. The app is designed to transform text based on user preferences and descriptions, leveraging a CrewAI-based multi-agent AI application.
## Key Features
### Text Transformation Options
The backend supports the following transformation capabilities:
1. **Formats**
- For details on supported formats, please refer to the [Expressly Wiki](https://github.com/DeepakPant93/expressly-app/wiki).
2. **Tones**
- For details on supported tones, please refer to the [Expressly Wiki](https://github.com/DeepakPant93/expressly-app/wiki).
3. **Target Audience**
- For details on supported target audiences, please refer to the [Expressly Wiki](https://github.com/DeepakPant93/expressly-app/wiki).
### Output
The backend processes user inputs and generates formatted text tailored to the specified preferences. Users can easily copy and utilize the output.
## Backend Configuration
### Prerequisites
1. Install `uv` and `crewai` if not already installed:
```bash
pip install uv crewai
```
2. Navigate to your project directory and install dependencies:
```bash
crewai install
```
(Optional: Lock dependencies using the CLI command.)
### Customization
1. Add environment variables to the `.env` file:
```plaintext
MODEL=gemini/gemini-1.5-flash
MODEL_API_KEY=<model_api_key> # Your API key here
```
Generate a new API key for GEMINI model from the [AI Studio](https://aistudio.google.com/app/apikey) website.
2. Modify configuration files as needed:
- `src/expressly_server/config/agents.yaml`: Agents configuration.
- `src/expressly_server/config/tasks.yaml`: Tasks configuration.
- `src/expressly_server/crew.py`: Crew configuration with custom logic, tools, and arguments.
- `src/expressly_server/main.py`: Entrypoint to kick off the crew with inputs for agents and tasks.
- `src/expressly_server/app.py`: FastAPI configuration.
- `src/expressly_server/web_app.py`: Gradio configuration.
### Running the Backend
To start the backend server and execute tasks:
```bash
crewai run
```
### Deployment
The app is deployed on Hugging Face Spaces. You can try it out [here](https://huggingface.co/spaces/deepakpant/expressly-app).
### Docker
Check the docker documentation [here](https://hub.docker.com/r/deepak93p/expressly-app). To run the docker image, use the following command:
```bash
docker run -p 7860:7860 -e MODEL="gemini/gemini-1.5-flash" -e MODEL_API_KEY="<model_api_key>" deepak93p/expressly-app
```
## Additional Notes
- Ensure all environment variables are correctly set in the `.env` file check for [.env.example](.env.example) file for reference.
- Regularly update your agents and tasks configuration to enhance functionality.
- Refer to the CrewAI documentation for advanced customizations.
|