Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 3.34 KB

README.md

File metadata and controls

71 lines (46 loc) · 3.34 KB
Raw

Trendy Toys

image

Welcome to the Trendy Toys project! This repository contains the code for a startup specializing in the sale of games, toys, and gaming equipment (Xbox, PlayStation, Baby-Foot, etc.). Our goal is to develop a website that highlights our products and attracts more customers.

Project Overview

This project aims to build a high-quality, user-friendly e-commerce website for Trendy Toys. We are committed to following best practices in web development to ensure a performant, accessible, and secure online experience.

Key Features:

  • E-commerce Functionality: Browse products, add to cart, checkout, and manage orders.
  • Product Showcase: Attractive displays of Trendy Toys' diverse product range.
  • User-Friendly Interface: Intuitive navigation and easy-to-use features.
  • Responsive Design: Seamless experience across all devices (desktop, mobile, tablet).
  • Accessibility: Accessible to all users, including those with disabilities.
  • Performance: Fast loading times and optimized performance.
  • Security: Robust security measures to protect user data.

Technology Stack:

  • JavaScript: Core programming language.
  • React JS: UI library for building user interfaces.
  • Functional Programming: Paradigm for writing clean and maintainable code.
  • Redux: State management library for predictable state updates.
  • HOFA Architecture: Combined architectural pattern for robust and scalable application structure (Hexagonal, Onion, Feature-sliced, Atomic Design).

Development Principles

We adhere to the SAGE(S) principles for development:

  • Semantic: Use semantic HTML for meaningful content structure.
  • Accessible: Follow accessibility guidelines (WCAG) to make the website usable for everyone.
  • Green: Build sustainable websites with optimized performance and resource usage.
  • Easy (KISS): Write simple, understandable, and maintainable code.
  • Secure: Implement robust security measures to protect user data.

Getting Started

Prerequisites:

  • Node.js and npm installed.

Installation:

  1. Clone the repository: git clone https://github.com/helabenkhalfallah/trendy-toys-web-site.git
  2. Install dependencies: npm install
  3. Start the development server: npm start

Documentation

For detailed information on coding standards, architectural decisions, and other technical guidelines, please refer to our Wiki. This includes:

  • React Development Checklist: Best practices for React development.
  • W3C Compliance Checklist: Guidelines for web standards compliance.
  • A11Y Checklist: Ensuring accessibility for all users.
  • Performance Checklist: Optimizing website performance.
  • Security Checklist: Implementing security best practices.
  • Browser Compatibility: Guidelines for cross-browser compatibility.
  • Architecture Decision Records (ADRs): Documentation of architectural decisions.

Contributing

We welcome contributions to the Trendy Toys project! Please see our Contribution Guidelines for more information.

Contact

For any questions or feedback, please open an issue on GitHub or contact us at [email protected].