Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Code Quality and Developer Experience with Husky Integration #11

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ node_modules
.vercel
.devcontainer.json
dist
.vscode
5 changes: 5 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules
dist
build
coverage
.env
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"semi": true,
"trailingComma": "es5",
"singleQuote": true,
"printWidth": 80,
"tabWidth": 2
}
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Stay on top of trending topics on social media — all in one place.**

Trend Finder collects and analyzes posts from key influencers, then sends a Slack notification when it detects new trends or product launches. This has been a complete game-changer for the @firecrawl_dev marketing team by:
Trend Finder collects and analyzes posts from key influencers , then sends a Slack notification when it detects new trends or product launches. This has been a complete game-changer for the @firecrawl_dev marketing team by:

- **Saving time** normally spent manually searching social channels
- **Keeping you informed** of relevant, real-time conversations
Expand All @@ -13,17 +13,20 @@ _Spend less time hunting for trends and more time creating impactful campaigns._
## How it Works

1. **Data Collection** 📥

- Monitors selected influencers' posts on Twitter/X using their API
- Uses Firecrawl to gather additional web data and context
- Runs on a scheduled basis using cron jobs

2. **AI Analysis** 🧠

- Processes collected content through Together AI
- Identifies emerging trends and patterns
- Detects product launches and significant conversations
- Analyzes sentiment and relevance

3. **Notification System** 📢

- When significant trends are detected, sends instant Slack notifications
- Provides context about the trend and its sources
- Enables quick response to emerging opportunities
Expand Down Expand Up @@ -89,23 +92,27 @@ SLACK_WEBHOOK_URL=https://hooks.slack.com/services/YOUR/WEBHOOK/URL
## Getting Started

1. **Clone the repository:**

```bash
git clone [repository-url]
cd trend-finder
```

2. **Install dependencies:**

```bash
npm install
```

3. **Configure environment variables:**

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

4. **Run the application:**

```bash
# Development mode with hot reloading
npm run start
Expand All @@ -117,6 +124,7 @@ SLACK_WEBHOOK_URL=https://hooks.slack.com/services/YOUR/WEBHOOK/URL
## Using Docker

1. **Build the Docker image:**

```bash
docker build -t trend-finder .
```
Expand All @@ -129,6 +137,7 @@ SLACK_WEBHOOK_URL=https://hooks.slack.com/services/YOUR/WEBHOOK/URL
## Using Docker Compose

1. **Start the application with Docker Compose:**

```bash
docker-compose up --build -d
```
Expand All @@ -145,6 +154,7 @@ trend-finder/
├── src/
│ ├── controllers/ # Request handlers
│ ├── services/ # Business logic
│ ├── lib/ # Shared utilities
│ └── index.ts # Application entry point
├── .env.example # Environment variables template
├── package.json # Dependencies and scripts
Expand Down
Loading