Skip to content

πŸ’‘ PubFlow is built to empower publishers with the right insights to make data-backed decisions and stay ahead in the competitive publishing industry. πŸš€

Notifications You must be signed in to change notification settings

phensalves/PubFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š PubFlow - Data-Driven Publishing Analytics

PubFlow is an advanced publishing analytics platform designed to help publishers, bookstores, and content creators track, analyze, and optimize their sales performance. With real-time insights and AI-powered analytics, PubFlow enables smarter business decisions, audience engagement, and optimized publishing strategies.

πŸš€ Features

  • πŸ“Š Sales Performance Dashboard - Visualize sales trends across genres, formats, and regions.
  • πŸ”Ž Advanced Search & Filtering - Find key insights with full-text search and smart filters.
  • πŸ€– AI-Driven Recommendations - Predict demand and optimize publishing strategies.
  • πŸ”— Multi-Channel Integration - Sync data from Amazon, Mercado Livre, Shopee, and other platforms.
  • πŸ“‘ ETL & Big Data Processing - Process large datasets efficiently for deeper analysis.
  • πŸ“ˆ Predictive Analytics - Leverage machine learning to forecast trends and sales behavior.
  • πŸ“‘ Customizable Reports - Generate PDF/CSV reports for internal strategy meetings.

πŸ”§ Tech Stack

  • Backend: Ruby on Rails 8 (API-Only)
  • Frontend: Next.js + Chart.js for analytics visualization
  • Database: PostgreSQL with Elasticsearch/OpenSearch for advanced search
  • AI & Data Processing: Python (Pandas, Scikit-learn for analytics)
  • Cloud & Scalability: Docker + AWS/GCP deployment

πŸ“‚ Project Structure

PubFlow/
│── backend/            # Ruby on Rails 8 API
│── frontend/           # Next.js application
│── database/           # PostgreSQL with Elasticsearch integration
│── docs/               # Documentation and API references
│── scripts/            # ETL and data processing scripts
│── tests/              # Unit and integration tests
│── docker-compose.yml  # Docker configuration

πŸ› οΈ Installation

Prerequisites:

  • Docker & Docker Compose installed
  • PostgreSQL installed (if running locally)
  • Node.js & Yarn (for the frontend)

Setup Steps:

git clone https://github.com/yourusername/pubflow.git
cd pubflow

Backend Setup:

cd backend
cp .env.example .env
bundle install
docker-compose up -d
rails db:create db:migrate db:seed
rails server

Frontend Setup:

cd frontend
yarn install
yarn dev

The frontend should now be running at http://localhost:3000 and backend at http://localhost:3001.

πŸ“Œ API Documentation

The API is documented using Swagger/OpenAPI. To access the API documentation, run the backend and navigate to:

http://localhost:3001/api-docs

πŸ“… Roadmap

  • Implement real-time sales tracking
  • Enhance AI-based trend prediction models
  • Expand integration with more book marketplaces
  • Develop a mobile-friendly dashboard

🀝 Contributing

We welcome contributions! To contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature-xyz)
  3. Commit your changes (git commit -m 'Added feature XYZ')
  4. Push to the branch (git push origin feature-xyz)
  5. Open a Pull Request

πŸ“œ License

This project is licensed under the MIT License.

πŸ“¬ Contact

For inquiries, reach out via [email protected] or open an issue in the repository.

πŸš€ PubFlow - Empowering Publishers with Data-Driven Insights!

About

πŸ’‘ PubFlow is built to empower publishers with the right insights to make data-backed decisions and stay ahead in the competitive publishing industry. πŸš€

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published