Reportly is a full-stack SaaS application for creating, managing, and collaborating on reports with AI-powered assistance.
- Rich Text Editor with Markdown support, image uploads, and code blocks
- AI-Powered Assistance for content generation and improvement
- Threaded Comments for collaborative feedback
- @Mentions to notify team members
- Gamification with XP, levels, and achievements
- Multi-tenant Architecture with Organizations and Workspaces
- Role-based Access Control for secure content management
- Real-time Notifications for user interactions
- Node.js v20.x+
- npm v10.x+
- MongoDB (local or Atlas)
- Supabase account
# Clone the repository
git clone https://github.com/your-organization/reportly.git
cd reportly
# Install dependencies
npm install
# Copy example environment file
cp .env.example .env.local
# Configure your environment variables
# Edit .env.local with your MongoDB, Supabase, and other credentials
# Start the development server
npm run devVisit http://localhost:3000 in your browser.
For detailed setup instructions, see the Getting Started Guide.
Comprehensive documentation is available in the docs directory:
- Quick Start Guide
- Getting Started Guide
- Setup Guide with Diagrams
- Project Overview
- Technical Architecture
- Technology Stack
- AI Collaboration
- Contributing Guide
# Run all tests
npm run test
# Run specific test suites
npm run test:unit
npm run test:integration
npm run test:e2e- Next.js - React framework
- MongoDB - Database
- Supabase - Authentication and storage
- TipTap - Rich text editor
- Tailwind CSS - Styling
- OpenAI - AI integration
- OpenRouter - AI provider alternative
This project was developed by:
Yatt-code (Aiyad) - Sole Human Developer - GitHub Profile
This project is licensed under the MIT License - see the LICENSE file for details.
- All the open-source projects that made this possible
- Our AI collaborators (see AI Collaboration)
- Our early users for their valuable feedback