Giter Club home page Giter Club logo

beafri-clady's Introduction

Beafri Clady

Beafri Clady is an e-commerce platform specifically designed for clothes, shoes, and fashion items. This project uses Django for the backend and includes a detailed structure for easy collaboration between backend and frontend developers.

Table of Contents

Features

Backend Features

  • User Authentication: User registration, login, and profile management.
  • Product Management: Adding, editing, and deleting products.
  • Shopping Cart: Adding items to the cart, updating quantities, and removing items.
  • Order Management: Placing orders, viewing order history, and managing orders.
  • Reviews and Ratings: Users can leave reviews and ratings for products.
  • Payment Integration: Integration with payment gateways for processing payments.

Frontend Features

  • Responsive Design: Ensuring a seamless experience across devices.
  • Product Display: Listing products with sorting and filtering options.
  • Cart Functionality: Viewing and modifying items in the cart.
  • Checkout Process: User-friendly checkout experience.
  • User Profiles: Viewing and editing user profiles.
  • Order Tracking: Tracking the status of orders.
  • Search Functionality: Searching for products.

Project Structure

BeafriClady/
├── beafri_clady/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
│   ├── asgi.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── registration/
│   │   │   ├── login.html
│   │   │   ├── register.html
│   │   ├── products/
│   │   │   ├── product_list.html
│   │   │   ├── product_detail.html
│   │   ├── cart/
│   │   │   ├── cart_detail.html
│   │   │   ├── checkout.html
│   │   ├── orders/
│   │   │   ├── order_confirmation.html
│   ├── static/
│   │   ├── css/
│   │   │   ├── styles.css
│   │   ├── js/
│   │   │   ├── scripts.js
│   │   ├── images/
│   ├── media/
├── accounts/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── views.py
│   ├── urls.py
│   ├── forms.py
│   ├── templates/
│   │   ├── accounts/
│   │       ├── profile.html
├── products/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── views.py
│   ├── urls.py
│   ├── forms.py
│   ├── templates/
│   │   ├── products/
│   │       ├── product_list.html
│   │       ├── product_detail.html
├── cart/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── views.py
│   ├── urls.py
│   ├── forms.py
│   ├── templates/
│   │   ├── cart/
│   │       ├── cart_detail.html
│   │       ├── checkout.html
├── orders/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── views.py
│   ├── urls.py
│   ├── forms.py
│   ├── templates/
│   │   ├── orders/
│   │       ├── order_confirmation.html
├── reviews/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── views.py
│   ├── urls.py
│   ├── forms.py
│   ├── templates/
│   │   ├── reviews/
│   │       ├── review_list.html
│   │       ├── review_form.html
├── manage.py
├── requirements.txt
├── README.md
├── .gitignore

Installation

  1. Clone the repository:

    git clone https://github.com/ngari-mwaniki/Beafri-Clady
    cd beafri_clady
  2. Create a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  3. Install dependencies:

    pip install -r requirements.txt
  4. Apply migrations:

    python manage.py makemigrations
    python manage.py migrate
  5. Create a superuser:

    python manage.py createsuperuser
  6. Run the development server:

    python manage.py runserver
  7. Access the site:

    Open your web browser and go to http://127.0.0.1:8000.

Usage

  • Admin Dashboard: Accessible at http://127.0.0.1:8000/admin with the superuser credentials.
  • User Authentication: Register and login to access user-specific features.
  • Product Management: Add, edit, and delete products from the admin dashboard.
  • Cart and Orders: Add products to the cart, proceed to checkout, and place orders.
  • Reviews: Leave reviews and ratings for products.

Running Tests

To run tests, use the following command:

python manage.py test

Contributing

  1. Fork the repository

  2. Create a new branch:

    git checkout -b feature/YourFeature
  3. Make your changes

  4. Commit your changes:

    git commit -m 'Add some feature'
  5. Push to the branch:

    git push origin feature/YourFeature
  6. Create a pull request

License

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


Beafri Clady - Your one-stop shop for fashion items.

beafri-clady's People

Stargazers

Fred Mwaniki avatar

Watchers

Fred Mwaniki avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.