Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
snipher-marube committed Aug 17, 2024
1 parent cd3f29d commit 661b2e8
Show file tree
Hide file tree
Showing 10 changed files with 225 additions and 25 deletions.
35 changes: 35 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Code of Conduct

## Introduction

We are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or any other personal characteristics.

## Expected Behavior

- Be respectful and considerate towards others.
- Use inclusive language and avoid offensive or discriminatory comments.
- Be open to constructive feedback and different opinions.
- Respect the privacy and personal boundaries of others.
- Do not engage in any form of harassment, trolling, or disruptive behavior.

## Unacceptable Behavior

The following behaviors are considered unacceptable and will not be tolerated:

- Harassment, intimidation, or discrimination of any kind.
- Offensive or derogatory comments, jokes, or slurs.
- Personal attacks or insults.
- Any form of trolling or disruptive behavior.
- Any other behavior that creates an uncomfortable or hostile environment.

## Reporting and Enforcement

If you witness or experience any violations of this code of conduct, please report it to [sniphermarube@gmail.com]. All reports will be kept confidential and will be promptly addressed by the appropriate team.

## Consequences

Violations of this code of conduct may result in temporary or permanent expulsion from the community or project, depending on the severity of the offense and the discretion of the administrators.

## Conclusion

By participating in our community or project, you agree to abide by this code of conduct. We strive to foster a positive and inclusive environment for everyone involved.
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to the Project

Thank you for considering contributing to the project! We welcome contributions from everyone. To ensure a smooth collaboration, please follow these guidelines when contributing to the project.

## Getting Started

1. Fork the repository and clone it locally.
2. Create a new branch for your contribution.
3. Make your changes and test them thoroughly.
4. Commit your changes with descriptive commit messages.
5. Push your branch to your forked repository.
6. Submit a pull request to the main repository.

## Code Style

- Follow the project's coding conventions and style guidelines.
- Write clear and concise code with meaningful variable and function names.
- Use comments to explain complex logic or important details.

## Testing

- Write unit tests for your code to ensure its correctness.
- Run the existing test suite before submitting your changes.
- Add new tests if necessary to cover your changes.

## Documentation

- Update the project's documentation if your changes affect it.
- Write clear and comprehensive documentation for new features or changes.

## Issue Tracker

- Check the issue tracker for open issues related to your contribution.
- If the issue doesn't exist, create a new one to discuss your proposal.

## Communication

- Be respectful and considerate when communicating with other contributors.
- Use the project's communication channels (e.g., Slack, Discord) for discussions.

## License

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

If you have any questions or need further assistance, please don't hesitate to ask. Happy contributing!
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2024] [Snipher Marube]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
53 changes: 53 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Django Ecommerce

This is a fully functional ecommerce website built with Django and Tailwind CSS.

## Features

- Account Registration: Users can create an account to access additional features.
- Product Catalog: Display a list of products with details such as name, price, and description.
- Shopping Cart: Users can add products to their cart and proceed to checkout.
- Order Management: Admins can manage orders, view order details, and update order status.
- Payment Integration: Integration with a payment gateway to process payments securely.
- User Authentication: Secure user authentication and authorization for protected areas of the site.
- Product Search: Users can search for products by name or category.
- Product Reviews: Users can leave reviews and ratings for products.
- Order History: Users can view their order history and track the status of their orders.
- Responsive Design: The website is optimized for different screen sizes and devices.

## Installation

1. Clone the repository:

```bash
git clone https://github.com/snipher-marube/django-ecommerce.git
```

2. Install the required dependencies:

```bash
pip install -r requirements.txt
```

3. Set up the database:

```bash
python manage.py migrate
```

4. Start the development server:

```bash
export DJANGO_SETTINGS_MODULE=DjangoEcommerce.settings.development
python manage.py runserver
```

5. Open your browser and visit `http://localhost:8000` to access the website.

## Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
56 changes: 56 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Security Policy

## Reporting a Vulnerability

If you discover a security vulnerability within our project, please send an email to [sniphermarube@gmail.com](mailto:sniphermarube@gmail.com). We take all security vulnerabilities seriously and will respond to your report promptly.

## Supported Versions

| Version | Supported |
| ------- | ------------------ |
| 1.0.x | :white_check_mark: |
| 0.9.x | :x: |
| 0.8.x | :x: |
| < 0.8 | :x: |

## Security Measures

We follow industry best practices to ensure the security of our project. Some of the measures we have implemented include:

- Regular code reviews
- Secure coding guidelines
- Input validation and sanitization
- Authentication and authorization mechanisms
- Encryption of sensitive data
- Regular security updates and patches

## Security Updates

We strive to promptly address any security vulnerabilities that are reported to us. When a vulnerability is confirmed, we will:

- Investigate the issue
- Develop and test a fix
- Release a security update as soon as possible
- Notify users about the vulnerability and the available fix

## Responsible Disclosure

We kindly request that you follow responsible disclosure practices when reporting security vulnerabilities to us. This includes:

- Providing us with sufficient details to reproduce and validate the vulnerability
- Allowing us a reasonable amount of time to address the issue before disclosing it to others
- Not exploiting the vulnerability or causing any harm to our systems or users

## Acknowledgements

We will acknowledge your report within 48 hours of receiving it.

## Scope

This security policy applies to vulnerabilities discovered in ([Django Ecommerce](https://github.com/snipher-marube/django-ecommerce.git)).

Please note that this policy does not cover security vulnerabilities in third-party dependencies. If you believe a vulnerability exists in a third-party dependency used by this project, please follow responsible disclosure practices and report it directly to the maintainers of the affected project.

## Contact

If you have any questions or concerns regarding the security of our project, please contact us at [sniphermarube@gmail.com](sniphermarube@gmail.com).
4 changes: 4 additions & 0 deletions static/css/output.css
Original file line number Diff line number Diff line change
Expand Up @@ -1783,6 +1783,10 @@ video {
background-color: rgb(220 38 38 / var(--tw-bg-opacity));
}

.bg-opacity-50 {
--tw-bg-opacity: 0.5;
}

.fill-\[\#CED5D8\] {
fill: #CED5D8;
}
Expand Down
Binary file added static/images/account/login.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 5 additions & 13 deletions templates/account/login.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{% load i18n %}
{% load allauth account %}
{% load socialaccount %}

{% load static %}
{% block title %}
Sign In
{% endblock title %}
Expand Down Expand Up @@ -95,8 +95,6 @@
</button>
</form>



<div class="py-12 text-center">
<p class="whitespace-nowrap text-gray-600">
If you have not created an account yet, then please
Expand All @@ -113,18 +111,12 @@
<div
class="pointer-events-none relative hidden h-screen select-none bg-black md:block md:w-1/2"
>
<div class="absolute bottom-0 z-10 px-8 text-white opacity-100">
<p class="mb-8 text-3xl font-semibold leading-10">
We work 10x faster than our compeititors and stay consistant. While
they're bogged won with techincal debt, we're realeasing new features.
</p>
<p class="mb-4 text-3xl font-semibold">John Elmond</p>
<p class="">Founder, Emogue</p>
<p class="mb-7 text-sm opacity-70">Web Design Agency</p>
</div>
<div
class="absolute top-0 h-full w-full bg-black bg-opacity-50"
></div>
<img
class="-z-1 absolute top-0 h-full w-full object-cover opacity-90"
src="https://images.unsplash.com/photo-1565301660306-29e08751cc53?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=687&q=80"
src="{% static 'images/account/login.jpg' %}"
/>
</div>
</div>
Expand Down
16 changes: 5 additions & 11 deletions templates/account/signup.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends 'base.html' %}
{% load allauth i18n %}
{% load socialaccount %}

{% load static %}
{% block title %}
SignUp
{% endblock title %}
Expand Down Expand Up @@ -114,18 +114,12 @@
<div
class="pointer-events-none relative hidden h-screen select-none bg-black md:block md:w-1/2"
>
<div class="absolute bottom-0 z-10 px-8 text-white opacity-100">
<p class="mb-8 text-3xl font-semibold leading-10">
We work 10x faster than our compeititors and stay consistant. While
they're bogged won with techincal debt, we're realeasing new features.
</p>
<p class="mb-4 text-3xl font-semibold">John Elmond</p>
<p class="">Founder, Emogue</p>
<p class="mb-7 text-sm opacity-70">Web Design Agency</p>
</div>
<div
class="absolute top-0 h-full w-full bg-black bg-opacity-50"
></div>
<img
class="-z-1 absolute top-0 h-full w-full object-cover opacity-90"
src="https://images.unsplash.com/photo-1565301660306-29e08751cc53?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=687&q=80"
src="{% static 'images/account/login.jpg' %}"
/>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion templates/includes/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<section
class="relative border-b border-gray-200 bg-white px-4 py-3 max-lg:min-h-[60px] md:flex lg:min-h-[80px] lg:items-center lg:px-10"
>
<a href="javascript:void(0)" class="shrink-0 max-sm:mb-3 max-sm:w-full"
<a href="{% url 'home' %}" class="shrink-0 max-sm:mb-3 max-sm:w-full"
><img
src="{% static 'images/logo/Logo.png' %}"
alt="logo"
Expand Down

0 comments on commit 661b2e8

Please sign in to comment.