Welcome to the GrapplTech Web Components Repository! This repository is dedicated to housing a variety of web component templates, including navbars, buttons, hero sections, footers, headers, sidebars, and more. These templates are contributed by students and reviewed by our team to ensure high quality. Our goal is to have a comprehensive library of web components ready for the feature launch on 15th August 2024.
Website Link: https://www.grappl.tech/gtcommunitycomponents
To contribute to this repository, please follow the steps outlined below:
-
Fork the Repository
- Navigate to the GrapplTech Web Components Repository on GitHub.
- Click the "Fork" button at the top right corner of the repository page to create a copy of the repository under your GitHub account.
-
Clone the Forked Repository
- Clone your forked repository to your local machine using the command:
git clone https://github.com/your-username/grappltech-web-components.git
- Navigate into the cloned repository:
cd grappltech-web-components
- Clone your forked repository to your local machine using the command:
-
Create a New Branch
- Create a new branch for your work:
git checkout -b your-full-name-category
- Replace
your-full-name-category
with your full name and the category you are working on, separated by a hyphen. For example,john-doe-hero-section
.
- Create a new branch for your work:
-
Add Your Component Template
- Create a new folder within the repository with your full name and category as the folder name. For example,
JohnDoeHeroSection
. - Add your component template files to this folder.
- Create a new folder within the repository with your full name and category as the folder name. For example,
-
Commit and Push Your Changes
- Add and commit your changes with a meaningful commit message:
git add . git commit -m "Added [Category] template by [Your Full Name]"
- Push your changes to your forked repository:
git push origin your-full-name-category
- Add and commit your changes with a meaningful commit message:
-
Create a Pull Request
- Go to the original GrapplTech Web Components Repository on GitHub.
- Click on the "Pull Requests" tab and then the "New Pull Request" button.
- Select your branch from the "compare" dropdown and click "Create Pull Request".
- Provide a clear title and description for your pull request, and submit it.
-
Review and Merge
- Our team will review your submission. If any changes are requested, please make them promptly.
- Once approved, your pull request will be merged into the main repository.
Please add your details to the table below after your pull request has been merged.
Full Name | Category | Deployed Link | Date | Tech Stack Used |
---|---|---|---|---|
Akhul | Hero Section | www.example.com | 19-06-2024 | HTML, CSS, JS |
Full Name | Category | Deployed Link | Date | Tech Stack Used |
---|---|---|---|---|
John Doe | Hero Section | Link | 15-07-2024 | HTML, CSS, JS |
- Ensure your code follows the best practices and is well-documented.
- Keep your component templates simple, reusable, and modular.
- Feel free to reach out to the repository maintainers if you have any questions or need assistance.
We look forward to your valuable contributions and thank you for being a part of the GrapplTech community!