Skip to content

Commit be33ea5

Browse files
authored
Update README.md
1 parent 83b3dab commit be33ea5

File tree

1 file changed

+116
-2
lines changed

1 file changed

+116
-2
lines changed

README.md

Lines changed: 116 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,116 @@
1-
# typeScript
2-
Learning TypeScript by building awesome projects and exploring its features. This repository contains my journey, code samples, and experiments with TypeScript.
1+
# 📘 TypeScript Learning Repository
2+
3+
Welcome to my **TypeScript Learning Repo** — a structured, hands-on journey from **basic** to **advanced** TypeScript concepts.
4+
This repository is perfect for **JavaScript developers**, **students**, and **beginners** who want to understand TypeScript clearly through practical code examples.
5+
6+
---
7+
8+
## 📂 Folder Structure
9+
10+
Each folder covers a specific topic, arranged in a learning sequence:
11+
12+
| Folder Name | Description | Date |
13+
|-----------------------|----------------------------------------|----------------|
14+
| `01_intro` | Introduction to TypeScript basics | Jun 26, 2024 |
15+
| `02_Basics` | Core types and basic syntax | Jun 26, 2024 |
16+
| `Generics` | Introduction to Generics | Jun 27, 2024 |
17+
| `Readonly_optional` | Readonly and optional properties | Jun 26, 2024 |
18+
| `Tuples` | Working with Tuples | Jun 26, 2024 |
19+
| `TypeAliases` | Using and creating Type Aliases | Jun 26, 2024 |
20+
| `classes` | Basics of Classes in TypeScript | Jun 26, 2024 |
21+
| `interface` | Understanding Interfaces | Jun 26, 2024 |
22+
| `union` | Working with Union types | Jun 26, 2024 |
23+
24+
---
25+
26+
## ⚙️ How to Run Locally
27+
28+
You can read the code directly, or run it locally for hands-on learning.
29+
30+
### ✅ Prerequisites
31+
32+
- Node.js installed 👉 [Download here](https://nodejs.org/)
33+
- TypeScript installed globally:
34+
```bash
35+
npm install -g typescript
36+
37+
## ⚙️ How to Run Locally
38+
39+
You can read the code directly, or run it locally for hands-on learning.
40+
41+
### ✅ Prerequisites
42+
43+
- Node.js installed 👉 [Download here](https://nodejs.org/)
44+
- TypeScript installed globally:
45+
```bash
46+
npm install -g typescript
47+
````
48+
49+
### ▶️ Run a File
50+
51+
1. Go to the desired folder:
52+
53+
```bash
54+
cd 01_intro
55+
```
56+
57+
2. Compile TypeScript to JavaScript:
58+
59+
```bash
60+
tsc filename.ts
61+
```
62+
63+
3. Run the compiled file:
64+
65+
```bash
66+
node filename.js
67+
```
68+
69+
**OR** use `ts-node` for instant execution:
70+
71+
```bash
72+
npm install -g ts-node
73+
ts-node filename.ts
74+
```
75+
76+
---
77+
78+
## 👨‍🏫 Who is this for?
79+
80+
***Beginners** exploring TypeScript for the first time
81+
***JavaScript developers** transitioning to TypeScript
82+
***Students** preparing for interviews or improving syntax understanding
83+
84+
---
85+
86+
## 🎯 Purpose
87+
88+
This repo is for **learning, reference, and revision**.
89+
You can read, clone, tweak, or extend it based on your understanding level.
90+
91+
---
92+
93+
## 🙌 Contributing to Yourself
94+
95+
* Fork or clone the repo
96+
* Play with the code
97+
* Add new examples as you learn
98+
99+
> Remember: *Practice beats theory — so try running the code!*
100+
101+
---
102+
103+
## 📅 Timeline Summary
104+
105+
Started learning on **June 26, 2024** and progressively added topics until completion.
106+
107+
---
108+
109+
Happy Learning & Keep Coding! 🚀
110+
111+
```
112+
113+
---
114+
115+
Let me know if you’d like to add a license, badges, or a "coming soon" section for future updates.
116+
```

0 commit comments

Comments
 (0)