Prerequisites

• Node.js (v14 or higher)
• npm or yarn
• Docker
• Docker Compose
• Slack workspace with webhook permissions
• API keys for required services

Environment Variables

Copy .env.example to .env and configure the following variables:

# Optional: API key from Together AI for trend analysis (https://www.together.ai/)
TOGETHER_API_KEY=your_together_api_key_here

# Optional: API key from DeepSeek for trend analysis (https://deepseek.com/)
DEEPSEEK_API_KEY=

# Optional: API key from OpenAI for trend analysis (https://openai.com/)
OPENAI_API_KEY=

# Required if monitoring web pages (https://www.firecrawl.dev/)
FIRECRAWL_API_KEY=your_firecrawl_api_key_here

# Required if monitoring Twitter/X trends (https://developer.x.com/)
X_API_BEARER_TOKEN=your_twitter_api_bearer_token_here

# Notification driver. Supported drivers: "slack", "discord"
NOTIFICATION_DRIVER=discord

# Required (if NOTIFICATION_DRIVER is "slack"): Incoming Webhook URL from Slack for notifications
SLACK_WEBHOOK_URL=https://hooks.slack.com/services/YOUR/WEBHOOK/URL

# Required (if NOTIFICATION_DRIVER is "discord"): Incoming Webhook URL from Discord for notifications
DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/WEBHOOK/URL

Getting Started

1. Clone the repository:

   git clone [repository-url]
   cd trend-finder
   

2. Install dependencies:

   npm install
   

3. Configure environment variables:

   cp .env.example .env
   # Edit .env with your configuration
   

4. Run the application:

   # Development mode with hot reloading
   npm run start
   
   # Build for production
   npm run build
   

Using Docker

1. Build the Docker image:

   docker build -t trend-finder .
   

2. Run the Docker container:

   docker run -d -p 3000:3000 --env-file .env trend-finder
   

Using Docker Compose

1. Start the application with Docker Compose:

   docker-compose up --build -d
   

2. Stop the application with Docker Compose:

   docker-compose down
   

Project Structure

trend-finder/
├── src/
│   ├── controllers/    # Request handlers
│   ├── services/       # Business logic
│   └── index.ts        # Application entry point
├── .env.example        # Environment variables template
├── package.json        # Dependencies and scripts
└── tsconfig.json       # TypeScript configuration

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request