AlertFlow

AlertFlow is a monitoring automation platform designed to streamline workflows, manage team members, and monitor project progress. This repository contains both the frontend and backend code for the AlertFlow application.

Table of Contents

• Features
• Installation
• Usage
• Project Structure
• Contributing
• License

Features

• Project Management: Create, edit, and delete projects.
• Flows: Create flows to design workflows per alarm pattern.
• Payloads: Receive incoming alarms from your monitoring infrastructure via payloads & flows.
• Runners: Manage self-hosted runners for executing tasks.
• Team Collaboration: Invite team members, assign roles, and manage permissions.
• Audit Logs: Track changes and activities within projects.

Installation

To get started with the AlertFlow project, follow these steps:

Backend

1. Clone the repository:

   git clone [email protected]:AlertFlow/alertflow.git
   cd alertflow

2. Install dependencies:

   cd services/backend && go mod download

3. Create a config.yaml file in the config directory and add the necessary configuration:

   LogLevel: info
   
   Database:
     Server: localhost
     Port: 5432
     Name: postgres
     User: postgres
     Password: postgres
   
   JWT:
     Secret: your-jwt-secret

4. Build and run the backend server:

   go build -o alertflow-backend
   ./alertflow-backend --config config/config.yaml

Frontend

1. Navigate to the frontend directory:

   cd services/frontend

2. Install dependencies:

   npm install

3. Create a .env.local file and add the necessary environment variables:

   NEXT_PUBLIC_API_URL="https://your-api-url.com"

4. Start the development server:

   npm run dev

Usage

Once the development server is running, you can access the application at http://localhost:3000. From there, you can create and manage projects, invite team members, and monitor project activities.

Project Structure

The project structure is organized as follows:

• backend: Contains the backend code for handling API requests, database interactions, and business logic.
• frontend: Contains the frontend code for the user interface, including components, pages, and styles.

Contributing

We welcome contributions to the AlertFlow project! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes and commit them:

   git commit -m "Add your commit message"

4. Push to the branch:

   git push origin feature/your-feature-name

5. Open a pull request on GitHub.

License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3. See the LICENSE file for details.