Paws & Claws

The Premier Pet Emporium

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• License
• Acknowledgements

About The Project

Pet Shop

Introduction

Project Hosted Link :- Hosted Link Pets And Claws

This repository contains the code for a pet shop application. The application allows users to browse and purchase various pets and pet-related products. It provides a convenient platform for pet lovers to find and acquire their desired pets while offering a range of pet care products.

Features

• Browse Different Categories of Pets:

  • Dogs: Explore various breeds, ages, and sizes of dogs available for adoption or purchase.
  • Cats: Discover a wide selection of cat breeds, ages, and temperaments to choose from.
  • Other Pets: Find different types of pets such as birds, rabbits, fish, reptiles, and more.

• View Detailed Pet Information:

  • Each pet listing includes comprehensive details such as breed, age, gender, price, and any special characteristics or requirements.
  • Users can view multiple images of each pet and read descriptions to make informed decisions.

• Add Pets to the Shopping Cart and Proceed to Checkout:

  • Users can add pets they wish to adopt or purchase to the shopping cart for a streamlined checkout process.
  • The shopping cart keeps track of selected pets, quantities, and total costs.

• Purchase Pet-Related Products:

  • In addition to pets, the pet shop offers a wide range of pet-related products to cater to various needs.
  • Users can explore and purchase pet food, toys, bedding, grooming supplies, and accessories.

• Apply Discounts or Promotional Codes During Checkout:

  • The application supports the application of discounts or promotional codes to provide users with savings on their purchases.

• Provide Customer Reviews and Ratings:

  • Users can leave reviews and ratings for pets they have adopted or purchased, helping others make informed decisions.

• Browse Different Categories of Pets:

  • Dogs: Explore various breeds, ages, and sizes of dogs available for adoption or purchase.
  • Cats: Discover a wide selection of cat breeds, ages, and temperaments to choose from.
  • Other Pets: Find different types of pets such as birds, rabbits, fish, reptiles, and more.

• View Detailed Pet Information:

  • Each pet listing includes comprehensive details such as breed, age, gender, price, and any special characteristics or requirements.
  • Users can view multiple images of each pet and read descriptions to make informed decisions.

• Add Pets to the Shopping Cart and Proceed to Checkout:

  • Users can add pets they wish to adopt or purchase to the shopping cart for a streamlined checkout process.
  • The shopping cart keeps track of selected pets, quantities, and total costs.

• Purchase Pet-Related Products:

  • In addition to pets, the pet shop offers a wide range of pet-related products to cater to various needs.
  • Users can explore and purchase pet food, toys, bedding, grooming supplies, and accessories.

• Apply Discounts or Promotional Codes During Checkout:

  • The application supports the application of discounts or promotional codes to provide users with savings on their purchases.

• Provide Customer Reviews and Ratings:

  • Users can leave reviews and ratings for pets they have adopted or purchased, helping others make informed decisions.

• Track Order Status and View Order History:

  • After completing a purchase, users can track the status of their orders and view their order history for reference.

• Buy and Sell Pets:

  • Users can browse through a wide range of available pets and choose to either adopt or purchase them.
  • Pet sellers can create listings for pets they wish to sell, including detailed information about the pet's breed, age, price, and more.

• Pet Care:

  • The application provides resources and information related to pet care, including articles, guides, and tips on pet health, grooming, training, and nutrition.
  • Users can access valuable insights and recommendations to ensure the well-being and proper care of their pets.

• Community:

  • The application fosters a community of pet lovers, allowing users to connect, share experiences, and engage in discussions related to pets.
  • Users can create profiles, post updates, comment on posts, and interact with other pet enthusiasts.

• Order Management:

  • The application offers a comprehensive order management system, allowing users to track their orders, view order history, and manage delivery details.

• Authentication and User Management:

  • The application includes user authentication and authorization mechanisms to secure user accounts and protect sensitive information.
  • Users can create accounts, log in, and manage their profiles and preferences.

Project Description

Many people consider their pets as members of the family and enjoy spending time with them. Pets provide unconditional love and support, which can be especially important during times of stress or loneliness. A pet shop is a retail establishment that sells various kinds of animals to the public, including domesticated pets such as dogs, and cats. In addition to animals, pet shops often offer a range of pet-related products, such as food, toys, bedding, grooming supplies, and accessories. Pet shops play an important role in providing people with the opportunity to acquire and care for pets, which can bring joy, companionship, and numerous health benefits. However, it's important to note that owning a pet is a significant responsibility, and prospective pet owners should carefully consider their ability to provide appropriate care and attention before making a purchase. With the increasing demand for high-quality pet care and products, many pet shops have evolved to offer a wide range of services.

Built With

The project is developed using the following technologies:

• Django: A high-level Python web framework used for building the application's backend.
• Python: The programming language used for the server-side logic and application development.
• HTML: The standard markup language used for creating the structure and content of web pages.
• CSS: The stylesheet language used for styling and customizing the visual presentation of the application.
• JavaScript: The programming language used for client-side interactivity and dynamic features.
• IBM DB2: The database system used for storing and managing pet-related data, including pet listings, user information, and orders.

Getting Started

To get started with the project, follow the instructions below:

Prerequisites

• Python: Make sure you have Python installed on your system. You can download it from the official Python website: Python.org

Installation

1. Clone the repository:

   git clone https://github.com/username/pet-shop.git

2. Navigate to the project directory: cd pet-shop

3. Install the project dependencies: pip install -r requirements.txt

Prerequisites

Before getting started with the project, ensure that you have the following prerequisites installed on your system:

Python: The project is developed using Python, so you need to have Python installed on your machine. You can download the latest version of Python from the official Python website: Python.org

• Make sure to select the appropriate version of Python compatible with your operating system.
• Follow the installation instructions provided by the Python installer for your operating system.

Check Python version : python --version

If Python is installed, it will display the installed Python version. If it's not installed, you'll need to download and install it before proceeding.

IBM DB2 Database : The project uses the IBM DB2 database for storing and managing pet-related data. Before running the project, you need to install and configure the IBM DB2 database on your system.

Visit the official IBM DB2 website to download the DB2 database software: IBM DB2

• Follow the installation instructions provided by the DB2 installer for your operating system.
• Configure the DB2 database with the necessary settings and create a new database for your pet shop application.

---

Note : Make sure to have the required credentials and connection details for accessing the DB2 database, as you will need to update the project's settings file (settings.py) with these details.

---

Installation

Follow the steps below to install and set up the project on your local machine:

1. Clone the repository to your local machine using the following command:

   git clone https://github.com/your-username/your-project.git

2. Navigate to the project directory: cd your-project/

3. Create a virtual environment to isolate project dependencies: python -m venv env

4. Activate the virtual environment:

   • For Windows: env\Scripts\activate
   • For macOS and Linux: source env/bin/activate

5. Install the required dependencies: pip install -r requirements.txt 6.Update the project's settings file (settings.py) with your DB2 database credentials and connection details. Replace the placeholders with the actual values: `# settings.py

Database configuration

DB2_HOST = 'your_db2_host' DB2_PORT = 'your_db2_port' DB2_DATABASE = 'your_db2_database' DB2_USER = 'your_db2_username' DB2_PASSWORD = 'your_db2_password' 7. Run the database migrations to set up the database:python manage.py migrate8. Start the development server:python manage.py runserver` 9. Open your web browser and access the project at http://localhost:8000.

You have successfully installed and set up the project on your local machine. Enjoy!

Usage

Follow the steps below to use the project:

1. Ensure that you have fulfilled the prerequisites and completed the installation steps mentioned in the "Prerequisites" and "Installation" sections of this readme.

2. Start the development server:

   python manage.py runserver
   

3. Open your web browser and navigate to http://localhost:8000 or the appropriate URL specified during the installation.

4. You will be directed to the home page of the pet shop application. From here, you can browse available pets, search for specific pets, and view detailed information about each pet.

5. To buy or sell a pet, you will need to create an account. Click on the "Sign Up" or "Register" button to create a new account. Fill in the required details and submit the form.

6. Once logged in, you can post pet listings for selling or interact with existing listings for buying pets. You can also access additional features such as pet care information and community forums.

7. Use the provided navigation menu or buttons to explore different sections of the application, update your profile, manage your listings, and engage with the pet-loving community.

8. Feel free to customize and enhance the application according to your specific requirements. You can modify the code, add new features, or integrate additional functionalities as needed.

9. Remember to properly maintain and update the project's settings file (settings.py) if you make any changes to the database configuration or other environment-specific settings.

Enjoy using the pet shop application and provide feedback or report any issues you encounter to improve the overall user experience.

Roadmap

Custom Roadmap

This roadmap outlines the planned features and milestones for the future development of the project. Please note that this roadmap is subject to change and may be updated based on project requirements and priorities.

Phase 1: Basic Functionality

• Implement user authentication and registration functionality.
• Develop a responsive and user-friendly user interface.
• Create a database schema for storing pet-related data.
• Allow users to browse and search for available pets.
• Enable users to view detailed information about each pet.

Phase 2: Buying and Selling Pets

• Add functionality for users to post pet listings for selling.
• Implement a buying system for users to purchase pets.
• Develop a messaging system for communication between buyers and sellers in community .

Phase 3: Pet Care and Community Features

• Provide pet care resources, including articles and guides using community.
• Enable users to join and participate in community forums.
• Implement social sharing features for pets and pet-related content.
• Introduce user profiles with customizable preferences and settings.

Phase 4: Advanced Features

• Develop a mobile application for improved accessibility.
• Enable users to create and manage pet events and meetups.
• Implement advanced search and filtering options for pets.

Phase 5: Performance Optimization and Refinements

• Optimize database queries and improve overall performance.
• Conduct thorough testing and bug fixing.
• Gather user feedback and make necessary improvements.
• Enhance security measures.

Please note that this roadmap is a general outline and may be adjusted as the project progresses. We value feedback and suggestions from the community, so feel free to contribute ideas and feature requests.

We are excited about the future development of the project and look forward to providing an exceptional pet shopping experience!

Contributing

Contributing

We welcome contributions from the community to improve the project and make it even better! If you would like to contribute, please follow the guidelines below:

Guidelines

1. Fork the repository and create your own branch for making changes.

2. Ensure that your code follows the project's coding style and conventions.

3. Make sure to test your changes thoroughly before submitting a pull request.

4. Provide clear and concise descriptions of the changes or improvements you have made in the pull request.

5. If you are working on a significant feature or major changes, it is recommended to discuss it first through the issue tracker or with the project maintainers.

6. Be respectful and considerate towards other contributors and maintainers.

7. Remember to update the documentation, including the README file, if necessary.

8. By contributing to this project, you agree to license your contributions under the project's license.

Contact

Thank you for your interest in contributing to our project! We appreciate your support and look forward to your contributions.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• NagiPragalathan - Backend Developer - NagiPragalathan - Overall project coordination and management, Database design and implementation , User authentication and access control.
• MohanKumar - Front & UI Designer - MohanKumar - Front-end development, UI/UX design, Integration
• Kavinitha - Tester & Developer - Kavinitha - API implementation, Data validation and handling
• Dharshan Prasath - Content and testing developer - Dharshan Prasath - Testing and quality assurance, Bug fixing and troubleshooting, Documentation and code comments