Skip to content

Project: Washing Machine Shop Website Development. Created at https://spectra.codes, which is owned by @Drix10

Notifications You must be signed in to change notification settings

coslynx/washing-machine-shop-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

60 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation


washing-machine-shop-website

A user-friendly website for a washing machine shop, built with React, Next.js, Tailwind CSS, and more.

Developed with the software and tools below.

Framework: React Frontend: Javascript, Html, Css Backend: Next.js LLMs: Custom, Gemini, OpenAI

git-last-commit GitHub commit activity GitHub top language

πŸ“‘ Table of Contents

  • πŸ“ Overview
  • πŸ“¦ Features
  • πŸ“‚ Structure
  • πŸ’» Installation
  • πŸ—οΈ Usage
  • 🌐 Hosting
  • πŸ“„ License
  • πŸ‘ Authors

πŸ“ Overview

This repository contains a web application called "washing-machine-shop-website" that provides a comprehensive solution for a washing machine shop's online presence, serving as a digital hub for product showcases, repair service bookings, customer engagement, and more. The project is built with a modern tech stack, including React, Next.js, Tailwind CSS, and custom LLMs.

πŸ“¦ Features

Feature Description
🏠 Homepage An engaging homepage with an eye-catching banner, shop description, and clear call-to-action buttons for customer interaction.
πŸ›’ Product Showcase A section to display washing machine models with high-quality images, detailed descriptions, and filtering options for easy navigation.
πŸ”§ Repair Services A detailed section outlining the shop's repair services, common issues addressed, pricing guidelines, and warranty information.
πŸ“… Online Booking A user-friendly online booking system for scheduling repair appointments at the customer's convenience.
πŸ“Έ Photo/Video Upload An option for customers to upload photos or videos of their washing machine issue for faster diagnosis and potential solutions.
🀝 About Us A page showcasing the shop's history, team, values, and positive customer testimonials to build trust and credibility.
πŸ“° Blog/News A section featuring informative blog posts or articles related to washing machine care, maintenance tips, and industry news.
πŸ“± Responsive Design The website is designed with a responsive layout, adapting to different screen sizes for optimal viewing on desktops, tablets, and smartphones.
πŸ€– AI-Powered Chatbot An AI-powered chatbot to provide instant support, answer common customer queries, and enhance customer satisfaction. (Optional)
πŸ‘“ Augmented Reality (AR) An immersive augmented reality experience allowing customers to virtually "try out" different washing machine models in their own homes. (Optional)
🎯 Personalized Recommendations The website analyzes user browsing history and preferences to provide personalized product recommendations. (Optional)
πŸ’³ Online Payment Integration A secure online payment gateway for customers to purchase products and book services directly on the website. (Optional)
πŸ† Loyalty Program A loyalty program to reward repeat customers, encourage ongoing engagement, and foster long-term customer relationships. (Optional)

πŸ“‚ Structure

washing-machine-shop-website
β”œβ”€β”€ public
β”‚   β”œβ”€β”€ assets
β”‚   β”‚   β”œβ”€β”€ images
β”‚   β”‚   β”‚   β”œβ”€β”€ hero-banner.jpg
β”‚   β”‚   β”‚   β”œβ”€β”€ washing-machines.jpg
β”‚   β”‚   β”‚   β”œβ”€β”€ repair-services.jpg
β”‚   β”‚   β”‚   β”œβ”€β”€ about-us.jpg
β”‚   β”‚   β”‚   β”œβ”€β”€ testimonials.jpg
β”‚   β”‚   β”‚   └── blog-posts.jpg
β”‚   β”‚   β”œβ”€β”€ fonts
β”‚   β”‚   β”‚   β”œβ”€β”€ roboto-regular.ttf
β”‚   β”‚   β”‚   β”œβ”€β”€ roboto-bold.ttf
β”‚   β”‚   β”‚   └── roboto-light.ttf
β”‚   β”‚   └── icons
β”‚   β”‚       β”œβ”€β”€ logo.svg
β”‚   β”‚       β”œβ”€β”€ shopping-cart.svg
β”‚   β”‚       β”œβ”€β”€ repair-tool.svg
β”‚   β”‚       β”œβ”€β”€ about-us.svg
β”‚   β”‚       β”œβ”€β”€ blog.svg
β”‚   β”‚       └── contact.svg
β”‚   └── favicon.ico
β”œβ”€β”€ components
β”‚   β”œβ”€β”€ Header.js
β”‚   β”œβ”€β”€ HeroBanner.js
β”‚   β”œβ”€β”€ ShopDescription.js
β”‚   β”œβ”€β”€ CallToAction.js
β”‚   β”œβ”€β”€ ProductCard.js
β”‚   β”œβ”€β”€ ProductFilters.js
β”‚   β”œβ”€β”€ RepairServicesSection.js
β”‚   β”œβ”€β”€ BookingForm.js
β”‚   β”œβ”€β”€ UploadForm.js
β”‚   β”œβ”€β”€ AboutUsSection.js
β”‚   β”œβ”€β”€ Testimonials.js
β”‚   β”œβ”€β”€ BlogPost.js
β”‚   β”œβ”€β”€ Footer.js
β”‚   └── Layout.js
β”œβ”€β”€ pages
β”‚   β”œβ”€β”€ index.js
β”‚   β”œβ”€β”€ products.js
β”‚   β”œβ”€β”€ repairs.js
β”‚   β”œβ”€β”€ about.js
β”‚   β”œβ”€β”€ blog.js
β”‚   └── contact.js
β”œβ”€β”€ styles
β”‚   β”œβ”€β”€ globals.css
β”‚   β”œβ”€β”€ components.css
β”‚   └── pages.css
β”œβ”€β”€ utils
β”‚   β”œβ”€β”€ fetchProducts.js
β”‚   β”œβ”€β”€ filterProducts.js
β”‚   β”œβ”€β”€ handleBooking.js
β”‚   β”œβ”€β”€ handleUpload.js
β”‚   β”œβ”€β”€ getTestimonials.js
β”‚   β”œβ”€β”€ getBlogPosts.js
β”‚   └── handleContactForm.js
└── server
    β”œβ”€β”€ index.js
    └── routes
        β”œβ”€β”€ products.js
        β”œβ”€β”€ repairs.js
        β”œβ”€β”€ testimonials.js
        β”œβ”€β”€ blog.js
        └── contact.js

πŸ’» Installation

πŸ”§ Prerequisites

  • Node.js (v18 or later recommended)
  • npm (or yarn)
  • Docker (Optional for development and deployment)

πŸš€ Setup Instructions

  1. Clone the repository:
    • git clone https://github.com/spectra-ai-codegen/washing-machine-shop-website.git
  2. Navigate to the project directory:
    • cd washing-machine-shop-website
  3. Install dependencies:
    • npm install

πŸ—οΈ Usage

πŸƒβ€β™‚οΈ Running the Project

  1. Start the development server:
    • npm run dev
  2. Open your browser and navigate to http://localhost:3000.

βš™οΈ Configuration

  • Environment Variables: Configure environment variables in a .env file at the root of the project. Refer to the .env.example file for available variables and their descriptions.
  • Database Configuration: Configure your PostgreSQL database connection details in the .env file.
  • API Keys: Configure API keys for services like Google Maps, Stripe, Twilio, and OpenAI in the .env file.

πŸ“š Examples

🌐 Hosting

πŸš€ Deployment Instructions

  • Vercel:
    1. Configure your Vercel project with the appropriate settings.
    2. Deploy your code using the Vercel CLI or the Vercel website.
    3. Set up environment variables in your Vercel project settings.
  • Netlify:
    1. Configure your Netlify project with the appropriate settings.
    2. Deploy your code using the Netlify CLI or the Netlify website.
    3. Set up environment variables in your Netlify project settings.
  • GitHub Pages:
    1. Configure your GitHub Pages deployment settings in the repository's settings.
    2. Push your code to the gh-pages branch.
  • AWS:
    1. Create an AWS S3 bucket to store your website files.
    2. Configure an AWS CloudFront distribution for serving your website content.
    3. Deploy your code to the S3 bucket.
  • Google Cloud:
    1. Create a Google Cloud Storage bucket to store your website files.
    2. Configure a Google Cloud CDN for serving your website content.
    3. Deploy your code to the Google Cloud Storage bucket.

πŸ”‘ Environment Variables

  • NEXT_PUBLIC_GOOGLE_MAPS_API_KEY: Google Maps API key
  • STRIPE_PUBLISHABLE_KEY: Stripe publishable key
  • TWILIO_ACCOUNT_SID: Twilio account SID
  • TWILIO_AUTH_TOKEN: Twilio auth token
  • OPENAI_API_KEY: OpenAI API key (Optional)

πŸ“œ API Documentation

πŸ” Endpoints

  • GET /api/products: Retrieves a list of washing machine products.
  • POST /api/bookings: Creates a new repair booking.
  • POST /api/uploads: Uploads images or videos related to a repair issue.
  • GET /api/testimonials: Retrieves customer testimonials.
  • GET /api/blog-posts: Retrieves blog posts.
  • POST /api/contact: Submits a contact form message.

πŸ”’ Authentication

The API endpoints do not require authentication.

πŸ“ Examples

  • curl -X GET http://localhost:3000/api/products
  • curl -X POST http://localhost:3000/api/bookings -H 'Content-Type: application/json' -d '{"customerName": "John Doe", "machineModel": "Samsung WF45R6300AW", "issueDescription": "Machine is not draining properly", "appointmentDate": "2024-10-26"}'

πŸ“œ License

This project is licensed under the GNU AGPLv3.

πŸ‘₯ Authors

🌐 Spectra.Codes

Why only generate Code? When you can generate the whole Repository!

Developer: Drix10 Website: Spectra.codes Backed by: Google, Microsoft, & Amazon for Startups Finalist: Backdrop Build v4