diff --git a/README.md b/README.md index 8d05d9d..6a2d617 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,123 @@ -# Shopy +# Learn -Welcome to Shopy! This is a React project for an online shopping platform. +This document provides instructions on how to set up and build the project locally. +This project is a clothing order website that allows user to add products , list their own products, make dashboard of seller + +## Prerequisites + +Before you begin, ensure you have the following installed on your local machine: + +- Node.js (v14.x or later) +- npm (Node Package Manager v6.x or later) + +## Table of Contents +- [Setup](#Setup) +- [Contributing Guidelines](#contributing-guidelines) +- [Getting Started](#getting-started) +- [Issue Management](#issue-management) +- [Communication and Collaboration](#communication-and-collaboration) +- [Deadline and Completion](#deadline-and-completion) +- [Quality and Learning](#quality-and-learning) ## Setup -Follow these steps to set up the project locally on your machine: +Follow these steps to set up the project locally: -### Prerequisites +1. Clone the repository to your local machine: -- Node.js (v14.x or later) -- npm (v6.x or later) + ```bash + git clone https://github.com/mohitparmar1/Shopy.git + ``` + +2. Navigate to the project directory: + + ```bash + cd SHOPY + ``` +3. Install project dependencies: + + ```bash + npm install + ``` + + ```bash + npm install vite + ``` + +4. Start the development server and run the app + + ```bash + npm run dev + ``` + +## Contributing Guidelines + +Before diving into the learning resources, please familiarize yourself with the following contributing guidelines: + +- Participants/contributors must comment on issues they wish to work on. +- Issues will be assigned on a first-come, first-serve basis by mentors or the Project Administrator (PA). +- Participants can open new issues using the provided template, but these need verification and labeling by a mentor or PA. +- Ensure issues are assigned to you before starting work. +- Each participant can work on a maximum of one issue at a time. +- Don't work on issues already assigned to others. +- Discuss issues with the team before starting work. +- Explain your approach to solving any issue in the comments for better understanding. +- Pull requests will be merged after review by a mentor or PA. +- Create PRs from branches other than `main`. +- Include a descriptive summary of your work in the PR description. +- Use the format `Fixes: issue number` in your commit message when creating a pull request. +- Complete assigned issues within the specified deadline. Failure to do so may result in reassignment. +- Follow project guidelines and coding style. +- Aim for structured and optimized code. +- Mistakes are allowed and part of the learning process! + +## Getting Started + +To contribute to the project, follow these steps: + +1. **Fork the Repository**: Start by forking the repository to your GitHub account. +2. **Clone the Repository**: Clone your forked repository to your local machine. +3. **Choose an Issue**: Comment on an issue you'd like to work on or open a new one following the guidelines. +4. **Set Up Development Environment**: Refer to the project's development guidelines for setting up your development environment. +5. **Start Working**: Once the issue is assigned to you, start working on it following your chosen approach. +6. **Submit a Pull Request**: After completing your work, submit a pull request from your branch for review. + +## Issue Management + +Issues are managed as follows: + +- Participants must comment on issues they wish to work on. +- Issues will be assigned on a first-come, first-serve basis. +- Participants can open new issues using the provided template, but these need verification and labeling by a mentor or PA. +- Ensure issues are assigned to you before starting work. +- Each participant can work on a maximum of one issue at a time. +- Don't work on issues already assigned to others. +- Discuss issues with the team before starting work. + +## Communication and Collaboration + +Effective communication and collaboration are crucial for successful contributions: + +- Discuss issues with the team before starting work. +- Explain your approach to solving any issue in the comments for better understanding. -### Clone the Repository +## Deadline and Completion -- Fork the Repo! +Ensure timely completion of assigned tasks: -```bash -git clone https://github.com//Shopy.git -``` +- Complete assigned issues within the specified deadline. +- Failure to meet the deadline may result in reassignment. -```bash -cd Shopy -``` +## Quality and Learning -```bash -npm install -``` +Learnings: +- Client-Side Development: Understanding how to build a user-friendly interface using React and TailwindCSS. +- Server-Side Development: Utilizing Node.js and Express for server-side logic and API integrations. +- Git Workflow: Understanding the Git workflow for contributing to open-source projects, including forking, branching, committing, and creating pull requests. -```bash -npm run dev -``` +Focus on quality and continuous learning: -Contributing -Contributions are welcome! Feel free to submit pull requests or raise issues for any improvements or bug fixes. +- Follow project guidelines and coding style. +- Aim for structured and optimized code. +- Mistakes are allowed and are a part of the learning process!