-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cd3f29d
commit 661b2e8
Showing
10 changed files
with
225 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters