ShabazBadshah/next-product-site

This website is to help beginners to contribute to the hacktoberfest and learn how to use Material UI in React projects. 🎃

[](#contributors-)

Hacktoberfest is celebration that runs from 1st - 31st October. It encourages people to get involved in open source to any public repository and join amazing communities.

🎃 Project: Coding up Product website 🎃

This is a service website design by Wahid Ari to showcase services provided by a start up. It's has a clean design and a great UX for beginners to start off with.

Technologies

• CSS
• React
• Material UI | MUI
• Vercel

---

Installation

    Use a command Prompt and type : npm install
    # or
    npm i

How To Use

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Steps to take to contribute to the project

1. Fork the repo and clone the forked repo on your local development environment.

https://github.com/your-USERNAME/next-product-site.git

1. Check the issue you want to tackle. The assets needed are in the website-assets folder. It includes svg and png images.
2. Create a branch using

    `git checkout -b feature/<feature-name>`
    `git checkout -b feature/<adding-hero-section>`
    `git checkout -b bug/<bug-name>`

1. Name the branch according to what it does. Example feature/added-hero-resource

2. • Stage all the changes using - git add .
   • Commit the staged changes using - git commit -m "your commit message". Make sure to write meaningful commit messages.
   • Before you push the commit make sure to pull the changes in the remote branch using git pull origin develop, in case of conflicts, please resolve them.
   • After pulling the changes, push the all the changes using git push --set-upstream origin new-branch

    git push --set-upstream origin feature/contribution-guidelines:develop

3. Create your PR into the Develop branch (not main branch).

4. Create a Pull Request against the develop branch, make sure you don't make PR against the main branch.

5. Write the Issue Number in the description if the pull request is related to some issue.

6. Leave a short message in the PR explaining in slightly more detail what the PR accomplishes.

7. If your PR touches multiple parts, consider adding a bullet list of accomplishments.

8. Amazing you just made your first successful Pull request. Just wait a few minutes for me to review and merge it.

Add your profile to the project

Go to the contributors.md file and add your profile there.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jane Tracy Muthoni 📆 💻 🚧 📖 🎨

Andre Westerlund 💻

This project follows the all-contributors specification. Contributions of any kind welcome!