SolAlerter is a blockchain alerting platform that enables users to seamlessly set alerts for tokens and nfts on Solana blockchain and get notified on Telegram using BLINKS.
- Simplified Blockchain Indexing: Connect directly to your PostgreSQL database and start indexing blockchain data with minimal setup
- Customizable Data Tracking: Select specific data categories to track based on your application needs
- Real-time Updates: Leverages Helius webhooks for real-time blockchain data synchronization
- User-friendly Interface: Intuitive dashboard for managing database connections and indexing configurations
- Scalable Architecture: Designed to handle multiple users and high data throughput
SOLALERTER/
├── backend/ # Main backend server
├── solalerter-web/ # Frontend web application
├── prisma-shared/ # Shared Prisma schema and DB utilities
├── .env # Environment variables
├── .env.example # Example environment configuration
├── .gitignore # Git ignore file
├── dockerfile # Docker configuration
├── README.md # Project documentation
- Backend: Node.js, Express
- Frontend: React, TypeScript
- Database: PostgreSQL, Prisma ORM
- Blockchain Integration: Helius API,
- Authentication: JWT, OAuth2
- Deployment: Docker, Kubernetes support
- Node.js (v16+)
- PostgreSQL (v14+)
- Helius API key (get one at https://helius.dev)
- Solana wallet (for submitting test transactions)
-
Clone the repository:
git clone https://github.com/ketan27j/solalerter.git cd solalerter
-
Set up environment variables:
cp .env.example .env # Edit .env with your configurations
-
Install dependencies:
# Install root dependencies npm install # Install dependencies for each package cd backend && npm install cd ../solalerter-web && npm install
-
Set up the database:
cd ../prisma-shared && npm install npx prisma migrate dev npm run build
-
Start the development servers:
# In separate terminals cd backend && npm run dev cd SolAlerter-web && npm run dev
Alternatively, you can use Docker to run the entire stack:
docker build -t solalerter .
docker run --name solalerter -p 3004:3004 -d solalerter
Key environment variables to configure:
# Database
DATABASE_URL=postgresql://user:password@localhost:5432/solalerter
# Helius API
HELIUS_API_KEY=your_helius_api_key
# Authentication
JWT_SECRET=your_jwt_secret
SESSION_SECRET=your_session_secret
- Create an account on the SolAlerter platform
- Navigate to the "Settings" section
- Enter your Telegram Id
- Save settings
- Go to the "Subscription" on dashboard
- Select data categories you want to track:
- Token
- NFT
- Configure specific parameters for each category
- Click "Start Indexing" to begin the process
- View real-time indexing status on the dashboard
- Modify indexing parameters as needed
SolAlerter consists of three main components:
- Backend API Server: Handles user authentication, telegram id management, and subscription setup
- Web Interface: Provides an intuitive UI for managing the platform
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.