Skip to content

rithuu24/logomatic-ai

Repository files navigation

🚀 Logomatic AI

Logo

GitHub stars

GitHub forks

GitHub issues

GitHub license

A Next.js application for managing and visualizing logs.

Live Demo | Documentation

📖 Overview

Logomatic AI is a Next.js application designed for efficient log management and analysis. It provides a user-friendly interface for viewing, filtering, and visualizing log data, enhancing debugging and monitoring capabilities. The application utilizes a PostgreSQL database for persistent log storage and leverages TypeScript for improved code maintainability and type safety.

✨ Features

  • 🎯 Real-time Log Streaming: View logs as they are generated.
  • 🔐 Secure Authentication: (Implementation details pending further code analysis)
  • 📱 Responsive Design: Accessible across various devices.
  • Efficient Data Handling: Optimized for handling large volumes of log data.

🖥️ Screenshots

Screenshot 1

Screenshot 2

🛠️ Tech Stack

Frontend:

Next.js

TypeScript

Tailwind CSS

Backend:

(To be completed after backend specifics are identified)

Database:

PostgreSQL

DevOps:

Docker

🚀 Quick Start

Prerequisites

  • Node.js (version >=16.0.0)
  • PostgreSQL (version >=13.0.0)
  • yarn or npm

Installation

  1. Clone the repository:

    git clone https://github.com/rithaa24/logomatic-ai.git
    cd logomatic-ai
  2. Install dependencies:

    yarn install
  3. Environment setup:

    cp .env.example .env
    # Configure your environment variables: DATABASE_URL, PORT (and any others detected in .env.example)
  4. Database setup: (Instructions will be added here based on database migration strategy detected in the codebase. Currently there is no migration script identified.) Create a PostgreSQL database with appropriate name and settings specified in .env.

  5. Start development server:

    yarn dev
  6. Open your browser: Visit http://localhost:3000

📁 Project Structure

logomatic-ai/
├── app/
│   └── ...
├── components/
│   └── ...
├── constants/
│   └── ...
├── db/
│   └── ...
├── docker-compose.yml
├── drizzle.config.ts
├── eslint.config.mjs
├── hooks/
│   └── ...
├── lib/
│   └── ...
├── middleware.ts
├── migrations/
│   └── ...
├── next.config.ts
├── package-lock.json
├── package.json
├── postcss.config.mjs
├── public/
│   └── ...
├── tailwind.config.ts
└── tsconfig.json

⚙️ Configuration

Environment Variables

| Variable | Description | Default | Required |

|-----------------|-------------------------------------------|-------------------------|----------|

| DATABASE_URL | PostgreSQL connection string | postgres://user:password@host:port/database | Yes |

| PORT | Port for the development server | 3000 | No |

| (Other variables) | (To be added after analyzing .env.example)| | |

🔧 Development

Available Scripts

| Command | Description |

|---------------|---------------------------------|

| yarn dev | Starts the development server |

| yarn build | Creates a production build |

🧪 Testing

(Testing framework and commands to be added after analysis of test files/configs)

🚀 Deployment

Production Build

yarn build

Deployment Options

(Deployment instructions to be added after analyzing deployment-related configurations like Dockerfile)

  • Docker: (Instructions will be added here after analyzing the Dockerfile)

🤝 Contributing

(Contributing guidelines to be added)

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.


⭐ Star this repo if you find it helpful!

Made with ❤️ by [rithaa24]

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages