From 26620fc04342c8c53790e833711ec2ac4aac2e3b Mon Sep 17 00:00:00 2001 From: Frank John Begornia Date: Mon, 5 Jan 2026 23:15:14 +0800 Subject: [PATCH] Update README.md to reflect project details and installation instructions --- readme.md | 84 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 70 insertions(+), 14 deletions(-) diff --git a/readme.md b/readme.md index a4d8d55..a30ac92 100644 --- a/readme.md +++ b/readme.md @@ -1,23 +1,79 @@ -## Laravel PHP Framework +# Crew Sportswear -[![Build Status](https://travis-ci.org/laravel/framework.svg)](https://travis-ci.org/laravel/framework) -[![Total Downloads](https://poser.pugx.org/laravel/framework/downloads.svg)](https://packagist.org/packages/laravel/framework) -[![Latest Stable Version](https://poser.pugx.org/laravel/framework/v/stable.svg)](https://packagist.org/packages/laravel/framework) -[![Latest Unstable Version](https://poser.pugx.org/laravel/framework/v/unstable.svg)](https://packagist.org/packages/laravel/framework) -[![License](https://poser.pugx.org/laravel/framework/license.svg)](https://packagist.org/packages/laravel/framework) +A custom sportswear and apparel e-commerce platform built with Laravel. -Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching. +## Production URL -Laravel is accessible, yet powerful, providing powerful tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked. +https://crewsportswear.com -## Official Documentation +## Requirements -Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs). +- Docker & Docker Compose +- PHP 7.4+ +- MySQL 5.7+ +- Composer +- Node.js & NPM -## Contributing +## Installation -Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions). +1. Clone the repository +2. Copy `.env.example` to `.env` and configure your environment variables +3. Install PHP dependencies: + ```bash + composer install + ``` +4. Install Node dependencies: + ```bash + npm install + ``` +5. Generate application key: + ```bash + php artisan key:generate + ``` +6. Run migrations: + ```bash + php artisan migrate + ``` -### License +## Docker Deployment -The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) +### Local Development +```bash +docker-compose -f docker-compose.local.yml up -d +``` + +### Development Environment +```bash +docker-compose -f docker-compose.dev.yml up -d +``` + +### Production Environment +```bash +docker-compose -f docker-compose.prod.yml up -d +``` + +The production environment uses Traefik as a reverse proxy with paid SSL certificate for crewsportswear.com. + +## Features + +- Custom sportswear design interface +- Product catalog and management +- Order processing and tracking +- User authentication and profiles +- Analytics integration +- Email notifications +- reCAPTCHA integration + +## Environment Variables + +Key environment variables (see `.env.example` for full list): +- `APP_ENV` - Application environment (local, development, production) +- `APP_URL` - Application URL +- `DB_*` - Database configuration +- `MAIL_*` - Mail server configuration +- `ANALYTICS_*` - Google Analytics configuration +- `CAPTCHA_*` - reCAPTCHA keys + +## License + +Proprietary - All rights reserved