Aries - Push Notification System

Aries is a simple and extendible push notification system. It is designed with simplicity, scalability and efficiency in the mind. You can modify individual components based on your needs.

Project Structure

The project is organized into several directories, each with a specific purpose:

• /cmd: Contains the entry points for the services. Each service has its own directory with a main.go file.
  • /engine
    • main.go # Entry point for engine
  • /pusher
    • main.go # Entry point for pusher
• /internal: Core application logic, organized by service.
  • /engine
    • /app # Application business rules (core logic)
    • /databases # Infrastructure (database, network code)
    • /interfaces # Interfaces (HTTP handlers, gRPC APIs)
  • /pusher
    • /app # Core application logic for pusher
    • /databases # Infrastructure for pusher
    • /interfaces # Interfaces for pusher
• /pkg: Shared libraries and utilities used across services.
• /config: Configuration files and environment specifics.
• /scripts: Scripts for building, running, and maintenance.
• /deployments: Dockerfiles and Kubernetes manifests for deployment.
• /docs: Documentation for the project.
• /tests: Tests, including integration and e2e tests.

Getting Started

Prerequisites

• Go 1.15 or higher
• Docker (for containerization)
• Kubernetes (for orchestration, optional)

Setting Up Your Local Development Environment

1. Clone the repository:

   git clone https://github.com/yourusername/my-go-project.git
   cd my-go-project

2. Install dependencies:

   go mod tidy

3. Set up environment variables:

   cp configs/example.env configs/.env
   edit configs/.env  # Modify the environment variables if necessary

Building the Application

To build all services, run the following command from the project root:

./scripts/build.sh