Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 64 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,67 @@
# website-component 📚
This repo includes frequently used web component for general websites.
Best Repo To Start Your Basics Website.
In This Repo All Things Are Available You Need To Know.
In-short The Best Repo For Small Project Like Webiste And Etc.

This repo includes frequently used web component for general websites. It is one of the best repos to start your basics website.

In this repo all things you need to know are available.

In-short: The best repo for small projects like webiste and etc.

# Contribute
This library is open-source so, You can add any of your components to this library.
This library is open-source so, you can add any of your components to this library.

## Steps to add Your component(s).
### 0. Start the repo.
### 1. Fork the repo.
After forking the repo you will obtain a copy of the repo in which you can make changes.
### 2. Make changes
Make changes in you fork by adding your components.
### 3. Generate a pr
Make pull request to this repo with your fork.
# Components added recently.
<details>
<summary>Accordian</summary>
<img src="repo.previews/IMG_20211011_111206.jpg"/>
<H1>Accordian by @CrackerSuman</H1>
<H2>Directory structure</H2>
<pre><code>
repo/accrodian/
/style.css (*style)
/index.html (demo)
<pre></code>
</details>
<details>
<img src="repo.previews/IMG_20211011_111151.jpg"/>
<summary>Pagination</summary>

<H1>Pagination by @dev-sumanpandit</H1>
<H2>Directory</H2>
<pre><code>
repo/Pagination/
/style.css (*style)
/index.html (demo)
<pre></code>
</details>
<details>
<summary>Toast</summary>
<img src="repo.previews/ezgif-3-30f21dc2121b.gif"/>
<H1>toast by @SGI-CAPP-AT2</H1>
<H2>Directory</H2>
<pre><code>
repo/toast/
/app.js (*script)
/style.css (*style)
/index.html (demo)
</pre></code>
</details>

## Implemention of components
For imImplementing any components of the repo download the (*) required files of the components and implemente it as it is implemented in demo files.
> Required files are denoted with (*)

### 1. Fork a project
Make a copy of the project to your account. Click on fork to create a copy of project to your account. This creates a separate copy for you to work on.

### 2. Clone the forked project
To get this project on your development machine we use clone command of git.

```
$ git clone (link of your forked project)
```

Now you have the project on your local machine.

### 3. Synchronizing your fork
It is necessary to make your forked copy equal with the original repository:

```
$ git push origin main
```

This command pushes the code to your forked repository on Github. The origin is the remote pointing to your forked repository on github.

Create a new branch for a feature or bugfix

All repositories have a main branch. You should establish a new branch and go to work on the issue:

```
$ git checkout -b <feature-branch>
```

This will create a new branch out of master branch. Now start working on the problem and commit your changes.

```
$ git add --all $
```

```
git commit -m "<commit message>"
```

The first command adds all the files. You can add specific files by removing -a and adding the file names.

The second command gives a message to your changes so you can know in future what changes this commit makes.

### 4. Push code and create a pull request
Push your new branch to your remote github fork:

```
$ git push origin <feature-branch>
```

Now you can help the project by opening a pull request. Click on create pull request and add a name to your pull request.

© 2021 ... and contributors
This project is licensed under the ... license.