Skip to content

Latest commit

 

History

History
287 lines (200 loc) · 10.9 KB

README.md

File metadata and controls

287 lines (200 loc) · 10.9 KB

Ecommerce SpectaStyle

Open Source Love svg1 PRs Welcome GitHub contributors GitHub repo size Hits

🌟 Stars 🍴 Forks 🐛 Issues Closed Issues 🔔 Open PRs 🔕 Close PRs last commit
Stars Forks Issues closed issues Open Pull Requests Close Pull Requests last commit

project-image

It is Full Stack Web Application made in MERN Stack it is End-to-End Encrypted website to order in shoe.

✅ Note

All the Contributors take the note all join discord server of GSSOC and go to FORUM and project-intro all should join in our project card and if any diffculty then you can ask there.

💻Techstack Uses:-

React.js logo

Express.js logo

JSX logo

CSS logo

Node.js logo

MongoDB logo

Mongoose logo

HTML5 logo

CSS3 logo

🚀 Demo

Website
Warehouse


✅ Internal Implemenation : MERN + JWT 🔐

app_design

🚀 Don't Forget to Star the Repo 🚀

🌟 If you find this repository useful or interesting, please consider giving it a star! It helps us understand how many users appreciate our work and motivates us to continue improving it. Thank you for your support! 🌟

🧐 Features

Here're some of the project's best features:

  • Succesfully Auth
  • Product Showcasing
  • Review Functionality
  • and many more..

The icons used in your instructions are relevant and intuitive for the steps described. However, here are a few suggestions for improvement, with some changes to make the icons more visually aligned with their respective actions:

🛠️ Installation Steps

  1. 🍴 Fork this repository.

    • Click the Fork button at the top-right corner of this repository page to create a copy of the repository under your GitHub account.
  2. 📥 Clone your forked copy of the project.

    git clone https://github.com/<your-username>/EcommerceSpectastyle.git
  3. 📂 Change the working directory.

    cd EcommerceSpectastyle
  4. 📁 Navigate to the Frontend folder.

    cd Frontend
  5. 📦 Install Frontend dependencies.

    npm install
  6. 🚀 Start the Frontend development server.

    npm run dev
  7. 📁 Navigate to the Backend folder.

    cd backend
  8. 📦 Install Backend dependencies.

    npm install
  9. 🚀 Start the Backend server.

    npm start

🐬 Local Setup with Docker

If you have Docker installed, you can easily set up the application locally with the following steps:

Clone the Repository and navigate to the working directory

Make sure you have docker installed on your system

docker-compose up --build

After the Image is build You can access it on:-

http://localhost:5173/

You are all set! 🎉

🔧 Creating a Pull Request

  1. 🌿 Create a new branch.

    git checkout -b <your_branch_name>
  2. 📊 Track your changes.

    git add .
  3. 💬 Commit your changes with a relevant commit message.

    • For example, if you added a new feature, you could use:

      git commit -m "Add feature X"
    • Or if you fixed a bug, you could use:

      git commit -m "Fix issue Y"
  4. 🚀 Push the committed changes in your feature branch to your remote repository.

    git push -u origin <your_branch_name>
  5. 🔄 Create a pull request.

    • Go to your forked repository on GitHub and click on Compare & pull request.
    • Ensure you compare your feature branch to the desired branch of the repository you are making a PR to.

🎉 Voila! You have successfully made a PR to the EcommerceSpectastyle project. Now, sit back, relax, and wait for the project maintainers to review your PR.

🍰 Contribution Guidelines:

Any contributor who wishes to contribute to this project should first read the README thoroughly. Study how the project is built and done; familiarize yourself with its structure and components. Take note of any bugs present in the project. If you find any raise an issue on the project's repository. Wait until a mentor assigns the issue to you. Once assigned start working on the development of the fix or improvement. After completing the development raise a pull request (PR) for the changes to be reviewed and merged into the project.

🍰 Issue MakingGuidelines:

Guidelines for Creating a Great Issue with Visual and Detailed Description

Title:

  • Choose a clear and descriptive title that summarizes the issue concisely.

Description:

  • Provide a detailed description of the issue, including its impact and any relevant background information.
  • Use clear and precise language to communicate the problem effectively.
  • Include any steps to reproduce the issue if applicable.
  • Mention any error messages or unexpected behavior observed.

Visuals:

  • Attach screenshots, gifs, or videos demonstrating the issue whenever possible.
  • Use annotations to highlight specific areas of interest in visuals.
  • Ensure visuals are clear and well-lit for easy understanding.

Steps to Reproduce:

  • Outline the steps necessary to reproduce the issue.
  • Include any prerequisites or specific conditions required for the problem to occur.

Expected Behavior:

  • Clearly state what behavior is expected under normal circumstances.

Actual Behavior:

  • Describe the behavior observed when the issue occurs.

Additional Information:

  • Provide any additional context or information that might be relevant to resolving the issue.
  • Include details such as browser or device information if the issue is platform-specific.
  • Mention any related issues or workarounds that have been attempted.

Priority and Labels:

  • Assign appropriate priority levels and labels to the issue to help with organization and prioritization.

Collaboration:

  • Encourage collaboration by inviting team members to provide input or assistance in resolving the issue.
  • Mention any specific individuals who may have relevant expertise or insights.

Deadline:

  • If you apply for issue the response will come in 4 to 5 hrs

Our Contributors ❤️

Thank you for your invaluable contributions to our project!

Contributors