Skip to content

Commit 605a72f

Browse files
committed
adding tech docu
1 parent 31aa57c commit 605a72f

File tree

10 files changed

+124
-11
lines changed

10 files changed

+124
-11
lines changed

docs/Technical/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Technical",
3+
"position": 5,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Nextjs is a web-based platform used for version control and collaboration. It allows developers to work together on projects from anywhere in the world. GitHub is built on top of Git, a distributed version control system created by Linus Torvalds in 2005."
7+
}
8+
}
258 KB
Loading
467 KB
Loading

docs/Technical/assets/image-1.png

159 KB
Loading

docs/Technical/assets/image-2.png

129 KB
Loading

docs/Technical/assets/img-3.png

140 KB
Loading

docs/Technical/assets/img-4.png

94.5 KB
Loading

docs/Technical/intro-github.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
id: intro-github
3+
title: Introduction of GitHub
4+
sidebar_label: Introduction of GitHub #displays in sidebar
5+
sidebar_position: 1
6+
tags:
7+
[
8+
GitHub,
9+
Introduction of GitHub,
10+
What is GitHub,
11+
Why learn GitHub,
12+
How to use GitHub,
13+
]
14+
description: In this tutorial, you will learn about GitHub, its importance, what is GitHub from Scratch, how to use GitHub, steps to start using GitHub, and more.
15+
---
16+
17+
GitHub is a web-based platform used for version control and collaboration. It allows developers to work together on projects from anywhere in the world. GitHub is built on top of Git, a distributed version control system created by Linus Torvalds in 2005.
18+
< />
19+
20+
:::note
21+
Key Features of SQL:
22+
GitHub will help you to control the version of the project on a large scale.
23+
24+
GitHub offers <a href="https://github.com/pricing">Premium</a> account for use, Premium users get unlimited Github Repo time, Storage etc.
25+
26+
:::
27+
28+
## How to start with GitHub?
29+
30+
Whenever you create something exciting or something new on your own, you always want to show it to others. As programmers, we also want to show our projects and codes to others, but how? So GitHub is the solution, it let's people to collaborate and scale the projects all on cloud. Some other example of simillar platform are , Bitbucket, GitLab, Beanstalk, etc. Many of them give you the facility to work on your code together as a team. Currently, Github is more popular than other above-listed platforms for hosting your code.
31+
:::info
32+
In the picture below you could see Developer 1, Developer 2... are working on the same project , lets say they are trying to build a amazon website, developer 1 handles the Mens shopping section, Developer 2 deals with Womens section, Developer 3 works on the login feature.
33+
34+
So each indivituals works on different feature from the copy of the central repository, once the development is done they push changes to the **remote repository** (central repo as per picture). Once **code review** happens and good to go, the senior developer will merge the code to the central repository so all the feature will be live on production.
35+
:::
36+
37+
<BrowserWindow url="https://github.com/" bodyStyle={{padding: 0}}>
38+
[![Visual Studio Code](./assets/1-Introduction-to-github.png)](https://code.visualstudio.com/)
39+
</BrowserWindow>
40+
41+
42+
43+
## What is Git??
44+
45+
So in the above example all the developer where able to work on different feautre simulatneaulsy because of the git. For uploading your project to your Github account, you need to install Git first. In other words, Git helps to do this version management of the files and coordinating work among the diverse team in the software development phase. Git is an open-source project and developed in 2005 by Linus Torvalds and Junior.
46+
47+
48+
49+
:::info
50+
1. **What is Version control System?**: To understand the version control system, let me give you one example; sometimes, you wish you have a record that contains all the changes you made in your code or your project. The version control systems are software tools that record all of your changes in the files. It is like a database of changes. Git is a version control system that most developers prefer to use. We will see how you can upload your code on Github using Git. With VCS you can track the branch, who made changes at what time, line of code added, retrive the previous version of changes.
51+
2. Basic Git Terminology::
52+
53+
| Keyword | Terminology | Description |
54+
| --- | --------------- | -------------------- |
55+
| VCS | Version Control System | Track changes to a collection of files |
56+
| SCM | Software configuration Management | Another name for VCS, the earlier version of VCS like CVS, SVN used to be centralised server, which cause single point of failure. |
57+
| DVCS | Distributed Version Control System| Git is distributed, the project history is stored both in client and server. Means you can make changes locally and remote. |
58+
| Working Tree | Tree | Current version of files where the active project is on |
59+
| Repo | Repository | Top of working Tree where git keep all records and history. |
60+
| Bare repo | | Not part of working Tree ends with .git, eg. backup.git |
61+
| Hash | 160 bit long SHA-1 | Based on the hash number, the file has been modified or not. |
62+
| Object | Git have 4 objects | Tree Object(directory, names), Blob Object(main file), Commit Object(spesfic versions), Tag(name attached to commit) |
63+
| Commit | | Makes Changes |
64+
| Branch | a series of Linked commit | The recent commit is called Head. |
65+
| Remote | | reference to other git repo |
66+
| | Git Command | Check this tutorial
67+
68+
:::
69+
70+
## Why Learn GitHub?
71+
72+
GitHub Simplfy all the command line interface of Git and make it more GUI friendly. GitHub has builds above of git. Here want we do is staging the files and doing the commit, You can clone the entire repository and create a branch and commit to that branch ask the main developer to merge the branch. when you clone in reality you are creating a copy of the real code/repository in your local environment.
73+
74+
[![Git Structure](./assets/2-git-strucutre.png)]
75+
76+
77+
:::info
78+
1. Basic GitHub Keywords::
79+
80+
| Category | Description |
81+
| --- | -------------------- |
82+
| Issues | Retrieve data from tables |
83+
| Discussions | |
84+
| Pull requests | |
85+
| Notifications | |
86+
| Labels | |
87+
| Actions | |
88+
| Forks | |
89+
| Projects | |
90+
91+
92+
The fork is a personal copy of the repo which is already present or uploaded in GitHub by a different user. Once you fork and make changes to the repository the changes will happen to your forked repo, not the real one.
93+
94+
:::
95+
96+
< />
97+
98+
### Watch the video Tutorial
99+
<iframe width="853" height="480" src="https://www.youtube.com/embed/GrTV59Y84S8?list=PLrLTYhoDFx-kiuFiGQqVpYYZ56pIhUW63" title="How to start with GitHub in 2024 | Beginner&#39;s Guide" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
100+
101+
< />
102+
103+
## Conclusion
104+
105+
If you think this Github Tutorial starter kit for Beginner was useful to you, then don’t forget to share it with others. Till then, we will meet For uploading your project to your Github account, you need to install Git first. which we will discuss in detail in the next post.

docusaurus.config.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,16 +97,16 @@ const config: Config = {
9797
type: "html",
9898
value: '<hr style="margin: 0.3rem 0;">',
9999
},
100-
// {
101-
// type: "html",
102-
// value: `<div class="grid grid-cols-3 gap-4">
103-
// <a class="border-r col-span-1" href="#" target="_self"> Interview Prep </a>
104-
// <div class="grid grid-cols-1 col-span-2">
105-
// <a href="#" target="_self" class="nav__icons"> 🧩Technical </a> <br />
106-
// <a href="#" target="_self" class="nav__icons"> 💡Behaviour </a>
107-
// </div>
108-
// </div>`,
109-
// },
100+
{
101+
type: "html",
102+
value: `<div class="grid grid-cols-3 gap-4">
103+
<a class="border-r col-span-1" href="#" target="_self"> Interview Prep </a>
104+
<div class="grid grid-cols-1 col-span-2">
105+
<a href="/docs/category/Technical/" target="_self" class="nav__icons"> 🧩Technical </a> <br />
106+
<a href="#" target="_self" class="nav__icons"> 💡Behaviour </a>
107+
</div>
108+
</div>`,
109+
},
110110
],
111111
},
112112
{

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"prism-react-renderer": "^2.3.0",
4242
"react": "^18.0.0",
4343
"react-dom": "^18.0.0",
44-
"react-firebaseui": "^0.0.1",
44+
"react-firebaseui": "^6.0.0",
4545
"react-icons": "^5.5.0",
4646
"rehype-katex": "^7.0.1",
4747
"remark-math": "^6.0.0",

0 commit comments

Comments
 (0)