Skip to content

Home

Jump to bottom
Elie El Debs edited this page Mar 30, 2026 · 1 revision

Good Karma Wiki

Welcome to the Good Karma project wiki! Here you will find all the information you need to understand, contribute to, and use the project.

Table of Contents

  1. Project Overview
  2. Roadmap
  3. Installation Guide
  4. Development Guidelines
  5. Testing
  6. Feature Proposals
  7. Contributing
  8. FAQ
  9. Contact & Community

Project Overview

Good Karma is an open-source platform for analyzing and improving Reddit posts using AI. It helps users optimize their content before publishing, leveraging KPIs, advice, and semantic analysis. The project is built with a Next.js frontend, FastAPI backend, and Qdrant vector database.

Roadmap

2026 Q2: Refactoring & Installer

  • Major codebase refactoring for maintainability and scalability.
  • Development of a user-friendly installer for easy setup.

2026 Q3: Testing & Industrialization

  • Implementation of comprehensive unit and integration tests.
  • Codebase industrialization: CI/CD, code quality checks, and documentation improvements.

2026 Q4: Image Analysis Features

  • Addition of image analysis capabilities (currently, only text is supported).
  • Integration of computer vision modules for richer post analysis.

2027 Q1: Generative AI Features

  • Implementation of generative AI functionalities, such as automatic rewriting of posts based on KPIs.
  • Advanced suggestions and content generation tailored to Reddit best practices.

Installation Guide

See the main README for up-to-date installation instructions. For advanced setup, refer to the backend and frontend guides.

Development Guidelines

  • Follow the code style and linting rules defined in the repository.
  • Write clear, concise commit messages.
  • Document new features and changes.
  • Open a pull request for all changes, and request a review from at least one maintainer.

Testing

  • All new features must include unit tests.
  • Run the test suite before submitting a pull request.
  • See CONTRIBUTING.md for details on running and writing tests.

Feature Proposals

If you have an idea for a new feature:

  1. Open a GitHub issue with the "feature" label.
  2. Describe the use case, expected behavior, and possible implementation details.
  3. Discuss with maintainers and the community before starting development.

Contributing

We welcome contributions! Please read our Code of Conduct and Contributing Guide before submitting issues or pull requests.

FAQ

Q: Who maintains Good Karma?
A: The project is maintained by Elie EL DEBS and Julien Champagne, with help from the open source community.

Q: How can I get support?
A: Open an issue on GitHub or join our community channels (see below).

Contact & Community

This wiki is a living document—feel free to suggest improvements or request new sections!

Clone this wiki locally