Skip to content

MFarhadA/gathering-ref

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

14 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Gathering Ref

Gathering Ref is a modern web application designed to help users gather images and photos for reference and create mood boards. Whether you're collecting visual inspiration for design projects, creative briefs, interior design, fashion, art direction, or any creative endeavor, Gathering Ref provides a comprehensive platform to organize and manage your visual references in one place.

Core Purpose

  • Image Collection: Gather and upload images or photos from various sources for reference
  • Mood Board Creation: Create and organize visual mood boards for projects
  • Reference Organization: Categorize and tag images for easy searching and retrieval
  • Public Sharing: Make galleries public so others can view your references and mood boards
  • User Management: Secure authentication system for personalized user experiences

πŸš€ Features

  • πŸ–ΌοΈ Image Upload & Collection - Upload and gather images for reference from various sources
  • 🎨 Mood Board Creation - Create visual mood boards to organize and showcase your references
  • πŸ“ Reference Organization - Categorize and tag images for easy searching and retrieval
  • πŸ” Authentication System - Complete auth flow with Supabase (register, login, forgot password, reset password)
  • πŸ“Š Dashboard - Personalized user dashboard to manage your references and mood boards
  • βš™οΈ Settings - User profile and application settings
  • 🎨 Modern UI - Clean, responsive design with Tailwind CSS
  • πŸ”’ Secure - Server-side rendering with proper security measures
  • πŸ“± Responsive - Mobile-first design approach

πŸ› οΈ Tech Stack

  • Framework: Next.js 14 (App Router)
  • Language: TypeScript
  • Styling: Tailwind CSS
  • Database/Auth: Supabase
  • Icons: Custom SVG icons
  • Font: Custom font optimization with next/font

πŸ“¦ Installation

  1. Clone the repository:

    git clone https://github.com/MFarhadA/gathering-ref.git
    cd gathering-ref
  2. Install dependencies:

    npm install
  3. Set up Supabase:

    • Create a new project at Supabase
    • Follow the setup guide in SUPABASE_SETUP.md
    • Copy your Supabase URL and anon key
    • Update your environment variables (see below)
  4. Set up environment variables: Create a .env.local file in the root directory with:

    NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
  5. Run the development server:

    npm run dev
  6. Open http://localhost:3000 in your browser.

πŸš€ Deployment

Vercel (Recommended)

  1. Push your code to GitHub
  2. Import project to Vercel
  3. Add environment variables:
    • NEXT_PUBLIC_SUPABASE_URL
    • NEXT_PUBLIC_SUPABASE_ANON_KEY
  4. Deploy!

Other Platforms

Build the application:

npm run build

Start in production:

npm start

πŸ“ Project Structure

β”œβ”€β”€ app/                    # Next.js App Router pages
β”‚   β”œβ”€β”€ api/               # API routes
β”‚   β”œβ”€β”€ auth/              # Authentication pages
β”‚   β”œβ”€β”€ components/        # Reusable components
β”‚   β”œβ”€β”€ dashboard/         # Dashboard page
β”‚   β”œβ”€β”€ g/                 # Group/gathering pages
β”‚   β”œβ”€β”€ login/             # Login page
β”‚   β”œβ”€β”€ register/          # Registration page
β”‚   β”œβ”€β”€ settings/          # Settings page
β”‚   β”œβ”€β”€ forgot-password/   # Forgot password page
β”‚   β”œβ”€β”€ reset-password/    # Reset password page
β”‚   β”œβ”€β”€ layout.tsx         # Root layout
β”‚   └── page.tsx           # Home page
β”œβ”€β”€ lib/                   # Utility functions and Supabase client
β”‚   β”œβ”€β”€ utils.ts           # Utility functions
β”‚   └── supabase/         # Supabase configuration
β”œβ”€β”€ public/                # Static assets
β”œβ”€β”€ styles/                # Global styles
└── config files           # TypeScript, ESLint, Tailwind configs

πŸ”‘ Key Features

Image & Reference Management

  • Image Upload: Upload and store images for reference
  • Reference Collections: Organize images into collections
  • Tagging System: Tag and categorize images for easy retrieval
  • Search: Find references quickly across your library

Mood Board Creation

  • Visual Mood Boards: Create boards to organize visual references
  • Drag & Drop: Easily arrange images on mood boards
  • Public Galleries: Make mood boards public so anyone can view them

Authentication Flow

  • Registration: Create account with email/password
  • Login: Secure login with session management
  • Password Reset: Forgot and reset password functionality
  • Session Management: Automatic session handling via Supabase

Dashboard

  • Personalized user experience
  • Quick access to your references and mood boards
  • User-specific content

Settings

  • Profile management
  • Account settings
  • Preference configuration

πŸ”§ Configuration

Supabase Setup

For detailed Supabase configuration, see SUPABASE_SETUP.md.

Environment Variables

Variable Description
NEXT_PUBLIC_SUPABASE_URL Your Supabase project URL
NEXT_PUBLIC_SUPABASE_ANON_KEY Your Supabase anonymous key

🎨 Customization

Styling

The project uses Tailwind CSS. You can customize the design by editing:

  • tailwind.config.ts - Tailwind configuration
  • app/globals.css - Global styles
  • Component files - Individual component styles

Fonts

The project uses custom fonts optimized with next/font. Configure fonts in app/layout.tsx.

πŸ“ License

This project is open source and available under the MIT License.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

πŸ“§ Support

For support, email support@gatheringref.com or open an issue on GitHub.

πŸ”— Links


Built with ❀️ using Next.js, Supabase, and Tailwind CSS

About

A web application designed to help users gather images and photos for reference and create mood boards.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors