Skip to content

Janvi75/canner

 
 

Repository files navigation

CannerAI - AI-Powered LinkedIn & Twitter Assistant

🚀 A sophisticated browser extension and backend system that enhances your social media productivity with AI-powered response suggestions and seamless content management.

License: MIT Docker TypeScript Python

✨ Features

  • Select from a variety of pre-defined response templates
  • Format linkedin post with Ease

🏗 Architecture

Here’s an overview of how Canner works internally:

Architecture Diagram

📄 Contributing

We welcome contributions! Please see our Contributing Guide for details.

  • Join our Discord community for discussions and support. Join Discord

🚀 Quick Start

Prerequisites

  • Docker & Docker Compose
  • MongoDB Atlas account (free tier) OR local MongoDB
  • Node.js 18+ (for browser extension development)
  • Chrome or Firefox browser

1. Set Up MongoDB

Option A: MongoDB Atlas (Recommended)

  1. Create a free account at MongoDB Atlas
  2. Create a new cluster (Free M0 tier available)
  3. Create a database user with read/write permissions
  4. Get your connection string (it will look like: mongodb+srv://username:password@cluster.mongodb.net/)
  5. Whitelist your IP address in Network Access

👉 New to MongoDB Atlas? Follow our detailed MongoDB Atlas Setup Guide

Option B: Local MongoDB

  1. Install MongoDB from mongodb.com
  2. Start MongoDB: sudo systemctl start mongod
  3. Your connection string will be: mongodb://localhost:27017/

2. Configure Backend

# Navigate to backend directory
cd backend

# Copy environment example file
cp .env.example .env.development

# Edit .env.development with your MongoDB credentials
# For Atlas: DATABASE_URL=mongodb+srv://username:password@cluster.mongodb.net/
# For Local: DATABASE_URL=mongodb://localhost:27017/

3. Start the Application

# From project root
docker compose up --build

# Backend will be available at http://localhost:5000
# Test it: curl http://localhost:5000/api/health

4. Build & Install Browser Extension

# Navigate to extension directory
cd browser-extension

# Install dependencies and build
npm install
npm run build

# Load in Chrome:
# 1. Go to chrome://extensions/
# 2. Enable "Developer mode"
# 3. Click "Load unpacked"
# 4. Select the browser-extension/dist/ folder

5. Verify Setup

Follow the Setup Verification Guide to ensure everything is working correctly.

A detailed Quick Start is written in our Contributing Guide. You can go through it for more details.

License

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

📞 Support

Made with ❤️ for developers who type the same things repeatedly

About

AI-Powered LinkedIn & Twitter Assistant

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 55.6%
  • CSS 23.1%
  • Python 12.0%
  • HTML 4.7%
  • JavaScript 2.2%
  • Makefile 1.2%
  • Other 1.2%