PhotoHub

Overview

This project is a software solution that began as an MVP (Minimum Viable Product) and is evolving toward a SaaS (Software as a Service) model. This README documents the current state of the project, its architecture, setup instructions, and future development plans.

Live Site: brunaalvesphoto.com

Table of Contents

• Current Status
• Features
• Technology Stack
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Architecture
• Screen Flow
• Architecture Diagram
• API Documentation
• Roadmap
• Contributing
• License

Current Status

The project is currently in MVP phase with core functionality implemented. We're preparing for the transition to a full SaaS solution with multi-tenancy, subscription management, and enhanced features.

Features

MVP Features (Implemented)

• Responsive landing page optimized for all device types
• Professional photography portfolio showcase
• WhatsApp integration for direct contact and quote requests
• Internationalization with full support for English and Portuguese languages
• SEO optimization for better visibility
• Modern and user-friendly interface

Planned SaaS Features

• User registration and secure authentication system
• Client dashboard for package selection and purchase
• Interactive photo gallery for clients to select pre-edited photos
• Option to choose additional photos beyond package limits
• Shopping cart functionality with specific pricing per additional photo
• Secure payment gateway integration
• High-resolution photo download capability for final deliverables
• Photographer administration area with:
  • Client management system
  • Appointment scheduling
  • Pre-edited photo upload interface
  • Final edited photo delivery system
• Automated workflows for photo approval and delivery
• Usage analytics and reporting
• Multi-tier subscription model

Technology Stack

• Frontend: Next.js, React, Tailwind
• Backend: Node.js, Express
• Database: Prisma, PostgreSQL
• Authentication: NextAuth.js
• Validation: Zod
• Hosting/Deployment: Vercel
• CI/CD: GitHub Actions

Getting Started

Prerequisites

• Node.js version 18.x or higher
• npm version 9.x or higher
• Express
• Prisma ORM
• PostgreSQL instance (local or cloud)
• NextAuth.js
• Zod (for schema validation)

Installation

# Clone the repository
git clone https://github.com/iurylenonalves/api-brunaphoto-vercel.git
cd api-brunaphoto-vercel

# Install dependencies
npm install

# Setup environment
cp .env.example .env.local
# Edit .env.local with your configuration

# Run the development server
npm run dev

Architecture

The project follows a modern architecture separating frontend and backend concerns while facilitating communication between them.

Frontend Architecture

The frontend for this project has been moved to a separate repository. You can find it here:

Frontend Repository - Bruna Photo

Backend Architecture

The backend follows a layered architecture pattern:

photoapp/
├── src/
│   ├── server/
│   │   │── controllers/
│   │   │── middlewares/
│   │   │── model/
│   │   └── routes/
├── .gitignore

Screen Flow

Screen Flow Diagram

Architecture Diagram

Architecture Diagram

API Documentation

The API endpoints follow RESTful conventions. Here are the key endpoints:

Contact Form

• POST /api/contacts: This endpoint allows users to send a contact message. The request body must include the following fields:

  • name (string, required): The name of the user.
  • email (string, required): The email address of the user.
  • message (string, required): The message content (maximum 1000 characters).

  Example Request:

  {
    "name": "John Doe",
    "email": "[email protected]",
    "message": "Hello, I would like to know more about your photography packages."
  }
  

Authentication and Users

• POST /api/auth/register: Register new user
• POST /api/auth/login: Sign in user
• GET /api/auth/profile: Get current session

Photo Packages

• GET /api/packages: Get photo Packages

Bookings

• POST /api/bookings: Create booking
• GET /api/bookings: Get user bookins

Photos

• GET /api/photos/pre-edited/1: Get pre-edited photos
• GET /api/photos/select: Select photos
• GET /api/photos/final/1/download: Download final photos

Payments

• GET /api/payments: Make payment

Roadmap

Phase 1: MVP (Completed)

• Implement core functionality
• Minimal viable UI/UX
• Integration with WhatsApp and Social Media
• Contact Form
• Consume backend API hosted on Vercel
• SEO optimization (metadata, OpenGraph, and sitemap.xml)
• Initial deployment (Vercel)
• Domain and hosting setup with Hostinger

Phase 2: SaaS Transition (In Progress)

• Basic authentication
• Refactor for multi-tenancy
• Authentication
• Photo Packages
• Bookings
• User Admin Photos
• Payments
• Implement subscription management
• Add usage quotas and rate limiting
• Enhance security measures

Phase 3: SaaS Expansion

• [ ]
• [ ]
• [ ]
• [ ]

Contributing

We welcome contributions to this project. Please follow these steps:

1. Fork the repository: api-brunaphoto-vercel
2. Clone your fork:

   git clone https://github.com/your-username/api-brunaphoto-vercel.git
   cd api-brunaphoto-vercel

3. Create a feature branch (git checkout -b feature/amazing-feature)
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

License

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