VigyBag

Table of Contents 📒

• Introduction 👋
• Repository 📒
• Features ⭐
• TechStacks ⚙️
• Contributing🤝
• Our Contributors ❤️

👋 Welcome

VigyBag is an e-commerce platform designed to empower villagers by providing them with a nationwide marketplace to sell their eco-friendly products across India. This platform bridges the gap between rural artisans and urban consumers, ensuring that their sustainable creations reach a wider audience.

Be vocal for local with Vigybag! Join us and be part of the Vigy family, explore a varied range of products, curated just for you!
Be a vigy and help us bridge the gap between you and your favourite local products.

🖌️Design Preview

📌Repository

Tired of scrolling through endless online stores that don't ship to your area?
Welcome to VigyBag - the ultimate online shopping destination for those looking to shop local! With our location-based platform, you can easily find and buy products from your favorite nearby shops. Whether you're a city slicker or living off the beaten path, VigyBag makes shopping a breeze. Say goodbye to long drives to the mall and hello to stress-free, convenient shopping with VigyBag!

✔Feature

• Search for products from 10 different broad categories.
• Get the best products at the best price.
• Local products, at your doorstep, just a click away.
• Compare prices and make purchases directly through the website.

🔑Tech Stacks

Technologies Used :

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

  🎥 Video Introduction

⌛Links for the Website

• Visit us!

Figma New Design

• Check it out here 👀

We accpet contributions to our project pertaining to the Code of Conduct and Contributing Guidelines stated below.

🤝 Contributing

Please read our Code of Conduct. We're accepting PRs for our open and unassigned issues. Please check CONTRIBUTING.md. We love contributions and welcome them as long as you respect the community and our rules! Kindly follow the steps below to get started:

1. Fork the repository.

2. Clone the forked repository.

git clone https://github.com/codervivek5/VigyBag.git

3. Navigate to the project directory.

cd VigyBag

4. Install all the required dependencies.

npm i

5. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/codervivek5/VigyBag.git

6. Check the remotes for this repository.

git remote -v

7. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.

git pull upstream main

8. Create a new branch.

git checkout -b <YOUR_BRANCH_NAME>

9. Make changes in the source code.

10. Check your changes.

git status

git diff

11. Stage your changes.

git add .

12. Commit your changes.

git commit -m "<your_commit_message>"

13. Push your local commits to the remote repo.

git push -u origin <your_branch_name>

14. To Create a PR to develop !) repository, click on compare and pull request.

15. Add an appropriate title and description to your PR explaining your changes.

16. Click on Create pull request

Congratulations🎉, you have made a PR to the VigyBag. Wait for your submission to be accepted and your PR to be merged by a maintainer.

🦄 Django Project Setup: For Backend Developers

1. Navigate to the project directory Backend Code.

cd Backend Code

2. Navigate to the project directory VigyBag.

cd VigyBag

3. If you get manage.py in the file structure then run this command.

python manage.py runserver

🦄 Django Admin Authentificaion

later on...

⚛️ React Project Setup

1. Navigate to the project directory Backend Code.

cd front-with-code

2. Navigate to the project directory VigyBag.

cd VigyBag

3. Run this command to install node packages.

npm install

⚛️ Start project

npm run dev

⚙️ IMPORTANT POINTS

• Ensure all code is original; copied work and plagiarism are strictly prohibited.

• Work only on assigned issues.

• Create a new issue and link your PR before making changes.

• Ensure your code compiles before submission.

• Use snake_case for file names and place files in the correct folder.

• Attach screenshots to illustrate your changes.

• Do not update the README.md

🚀 Usage Once you have VigyBag running, you can:

Use the search functionality to find products based on your chosen category. Explore nearby stores and compare prices easily. 🧪 Testing To run tests for VigyBag, use the following command:

Run tests

pytest

🌐 Deployment

To deploy VigyBag to a production server :

1. Configure your production environment settings.
2. Set up databases and other required services.
3. Ensure all dependencies are installed and updated.
4. Deploy the application using your preferred method (e.g., Docker, Heroku, AWS).

❓ Troubleshooting

If you encounter any issues while setting up or using VigyBag, try the following:

• Double-check your environment setup against the installation instructions.
• Search for similar issues in the project's GitHub Issues.
• Reach out to the community or project maintainers for assistance.

🙂 Project Admin:

😍 Our Contributors :

Made with contrib.rocks.

🛡️ License

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

📬 Contact:

If you want to contact me, you can reach me through below handles.

Thank you for considering contributing to VigyBag. We look forward to your valuable contributions!

© 2022-2024 Coder Vivek

(Back to top)