Skip to content

Commit 9875de4

Browse files
Sooraj-krishnaSooraj-krishna
authored
Merge pull request #2 from shadil-rayyan/main
intial version
2 parents 392541f + f507464 commit 9875de4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2885
-1
lines changed

‎.github/workflows/doc.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Docs
2+
3+
concurrency:
4+
group: ${{ github.workflow }}-${{ github.ref }}
5+
cancel-in-progress: ${{ github.ref != 'refs/heads/dev' }}
6+
7+
on:
8+
workflow_dispatch:
9+
push:
10+
branches:
11+
- main
12+
- dev
13+
14+
permissions:
15+
contents: read
16+
packages: write
17+
pages: write
18+
id-token: write
19+
20+
jobs:
21+
Deploy:
22+
environment:
23+
name: github-pages
24+
url: ${{ steps.deployment.outputs.page_url }}
25+
26+
runs-on: ubuntu-latest
27+
28+
steps:
29+
# 1. Checkout the repository
30+
- name: Checkout
31+
uses: actions/checkout@v4
32+
33+
34+
35+
# 3. Setup Python
36+
- uses: actions/setup-python@v5
37+
with:
38+
python-version: '3.x'
39+
40+
# 4. Generate Docs (inline MkDocs build)
41+
- name: Generate Docs
42+
run: |
43+
set -ex
44+
python3 -m venv venv
45+
source venv/bin/activate
46+
pip install --upgrade pip
47+
pip install mkdocs mkdocs-material mkdocs-redirects \
48+
mkdocs-minify-plugin mkdocs-awesome-pages-plugin \
49+
mkdocs-macros-plugin mkdocs-codeinclude-plugin
50+
mkdocs build --clean
51+
deactivate
52+
53+
# 4. Configure GitHub Pages
54+
- name: Setup Pages
55+
uses: actions/configure-pages@v4
56+
57+
# 5. Upload Pages Artifact
58+
- name: Upload Pages Artifact
59+
uses: actions/upload-pages-artifact@v3
60+
with:
61+
path: './site'
62+
63+
# 6. Deploy to GitHub Pages
64+
- name: Deploy to GitHub Pages
65+
id: deployment
66+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
*.egg-info/
24+
.installed.cfg
25+
*.egg
26+
27+
# PyInstaller
28+
# Usually these files are written by a python script from a template
29+
*.manifest
30+
*.spec
31+
32+
# Installer logs
33+
pip-log.txt
34+
pip-delete-this-directory.txt
35+
36+
# Unit test / coverage reports
37+
htmlcov/
38+
.tox/
39+
.nox/
40+
.coverage
41+
.coverage.*
42+
.cache
43+
nosetests.xml
44+
coverage.xml
45+
*.cover
46+
*.py,cover
47+
.hypothesis/
48+
.pytest_cache/
49+
cover/
50+
51+
# Translations
52+
*.mo
53+
*.pot
54+
55+
# Django stuff:
56+
*.log
57+
local_settings.py
58+
db.sqlite3
59+
60+
# Flask stuff:
61+
instance/
62+
.webassets-cache
63+
64+
# Scrapy stuff:
65+
.scrapy
66+
67+
# Sphinx documentation
68+
docs/_build/
69+
70+
# PyBuilder
71+
target/
72+
73+
# Jupyter Notebook
74+
.ipynb_checkpoints
75+
76+
# IPython
77+
profile_default/
78+
ipython_config.py
79+
80+
# pyenv
81+
.python-version
82+
83+
# pipenv
84+
Pipfile.lock
85+
86+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
87+
__pypackages__/
88+
89+
# Celery stuff
90+
celerybeat-schedule
91+
celerybeat.pid
92+
93+
# SageMath parsed files
94+
*.sage.py
95+
96+
# dotenv
97+
.env
98+
.env.*
99+
100+
# virtualenv
101+
venv/
102+
ENV/
103+
env/
104+
env.bak/
105+
venv.bak/
106+
107+
# Spyder project settings
108+
.spyderproject
109+
.spyproject
110+
111+
# Rope project settings
112+
.ropeproject
113+
114+
# mkdocs documentation
115+
/site
116+
117+
# mypy
118+
.mypy_cache/
119+
.dmypy.json
120+
dmypy.json
121+
122+
# Pyre type checker
123+
.pyre/
124+
125+
# pytype static type analyzer
126+
.pytype/
127+
128+
# Cython debug symbols
129+
cython_debug/
130+
131+
# VS Code settings
132+
.vscode/

‎README.md‎

Lines changed: 155 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,155 @@
1-
# cse-student-starter-guide
1+
2+
# 🚀 CSE Starter Guide Kit
3+
4+
![License](https://img.shields.io/badge/License-MIT-blue)
5+
![Contributors](https://img.shields.io/badge/Contributors-Open-brightgreen)
6+
![GitHub stars](https://img.shields.io/github/stars/shadil-rayyan/cse-student-starter-guide)
7+
![GitHub forks](https://img.shields.io/github/forks/shadil-rayyan/cse-student-starter-guide)
8+
![GitHub last commit](https://img.shields.io/github/last-commit/shadil-rayyan/cse-student-starter-guide)
9+
10+
**CSE Starter Guide Kit** is a curated, beginner-friendly guide and resources kit for computer science students to learn core concepts, domains, tools, and career essentials.
11+
12+
---
13+
14+
## 🎯 Table of Contents
15+
- [🚀 CSE Starter Guide Kit](#-cse-starter-guide-kit)
16+
- [🎯 Table of Contents](#-table-of-contents)
17+
- [📝 About](#-about)
18+
- [✨ Features](#-features)
19+
- [🚀 Getting Started](#-getting-started)
20+
- [📂 Folder Structure](#-folder-structure)
21+
- [🖼 Screenshots](#-screenshots)
22+
- [🎬 Demo](#-demo)
23+
- [🤝 Contributing](#-contributing)
24+
- [📚 Resources](#-resources)
25+
- [📜 License](#-license)
26+
- [📬 Contact](#-contact)
27+
28+
---
29+
30+
## 📝 About
31+
32+
This guide is built for **college-level CSE students** who want a structured roadmap from fundamentals to domain exploration, daily reading habits, and career preparation.
33+
It covers:
34+
35+
- Programming languages & tools
36+
- Linux, Git, GitHub, and productivity tips
37+
- Domains like AI, Web Development, Game Development, Embedded Systems
38+
- College life hacks, hackathons, placements, scholarships
39+
- Open-source participation & social media guidance
40+
41+
---
42+
43+
## ✨ Features
44+
45+
- Beginner-friendly & structured for easy navigation
46+
- Multi-domain coverage (Android, AI, Web, Blockchain, DevOps, etc.)
47+
- Career guidance (resume, portfolio, hackathons)
48+
- Open-source programs and contribution guides
49+
- Cheat sheets, resources, and FAQs
50+
- Offline-ready MkDocs website
51+
52+
---
53+
54+
## 🚀 Getting Started
55+
56+
**1. Clone the repository**
57+
```bash
58+
git clone https://github.com/shadil-rayyan/cse-student-starter-guide.git
59+
cd cse-student-starter-guide
60+
````
61+
62+
**2. Install dependencies**
63+
64+
```bash
65+
pip install mkdocs-material mkdocs-minify-plugin mkdocs-awesome-pages-plugin mkdocs-macros-plugin mkdocs-codeinclude-plugin
66+
```
67+
68+
**3. Serve locally**
69+
70+
```bash
71+
mkdocs serve
72+
```
73+
74+
**4. Build for GitHub Pages**
75+
76+
```bash
77+
mkdocs build
78+
mkdocs gh-deploy
79+
```
80+
81+
---
82+
83+
## 📂 Folder Structure
84+
85+
```
86+
├── assets
87+
│ └── logo.png
88+
├── college
89+
├── core
90+
├── daily-reading
91+
├── domain
92+
├── job
93+
├── open-source
94+
├── social-media
95+
├── index.md
96+
├── about.md
97+
├── resources.md
98+
├── cheatsheet.md
99+
├── faq.md
100+
└── contributing.md
101+
```
102+
103+
---
104+
105+
## 🖼 Screenshots
106+
107+
**Home Page**
108+
109+
![Home](images/home.png)
110+
111+
**Domain Section**
112+
113+
![Domain](images/domain.png)
114+
115+
**Job & Resume Section**
116+
117+
![Job](images/job.png)
118+
119+
---
120+
121+
## 🎬 Demo
122+
123+
Live site: [https://shadil-rayyan.github.io/cse-student-starter-guide/](https://shadil-rayyan.github.io/cse-student-starter-guide/)
124+
125+
* Interactive sidebar navigation
126+
* Search and instant navigation
127+
* Inline code copy and cheat sheets
128+
* Fully responsive and mobile-friendly
129+
130+
---
131+
132+
## 🤝 Contributing
133+
134+
Contributions are welcome! See [contributing.md](contributing.md) for guidelines.
135+
Steps: Fork → Branch → Commit → Pull Request
136+
137+
---
138+
139+
## 📚 Resources
140+
141+
Check [resources.md](resources.md) for curated books, websites, courses, and tools to accelerate your CSE journey.
142+
143+
---
144+
145+
## 📜 License
146+
147+
This project is licensed under the [MIT License](LICENSE).
148+
149+
---
150+
151+
## 📬 Contact
152+
153+
* LinkedIn: [Shadil AM](https://www.linkedin.com/in/shadil-am/)
154+
* GitHub: [shadil-rayyan](https://github.com/shadil-rayyan)
155+
* Email: [your-email@example.com](mailto:codecompass2024@gmail.com)

‎docs/assets/logo.png‎

56.3 KB
Loading

‎docs/cheatsheet.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Cheat Sheets for CSE Students
2+
3+
Quick references to save time while coding or working on projects.
4+
5+
## 🖥 Programming
6+
- **Python**
7+
```python
8+
# Swap two variables
9+
a, b = b, a
10+
# List comprehension
11+
squares = [x*x for x in range(5)]

‎docs/college/hackathon.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
3+
# Hackathons : Why You Should Join
4+
5+
When you first hear the word **hackathon**, you might think it’s about hacking into systems. But actually, hackathons are events where students, developers, and innovators come together to **build projects in a short time**—usually 24 to 48 hours.
6+
7+
### 🌟 Why Join a Hackathon?
8+
9+
1. **Learn by Doing** – In class you study theory, but hackathons let you turn ideas into real projects. You gain hands-on skills faster than normal.
10+
2. **Teamwork** – You’ll work with friends or new people, just like in real companies. This helps improve communication and collaboration.
11+
3. **Speed & Focus** – A project that normally takes weeks is built in days because hackathons push you to focus and avoid procrastination.
12+
4. **Networking** – Many tech companies and mentors attend hackathons. Some even secretly watch participants and invite them for **internships or interviews**.
13+
5. **Placements & Offers** – Today, many companies hire directly through hackathons. If you build something creative, it can open the door to **job offers and PPOs (Pre-Placement Offers)**.
14+
15+
### 🚩 Myths About Hackathons
16+
17+
* **“They are only for experts.”** – Wrong! Beginners learn the most.
18+
* **“It’s only coding.”** – No, design, ideas, and teamwork matter too.
19+
* **“It won’t help in future.”** – In reality, hackathons are becoming a **key path for placements** in tech companies.
20+
21+
### 🔮 Why Hackathons Are the Future
22+
23+
Companies love students who can **think, build, and deliver under pressure**. That’s exactly what hackathons test. For CSE students, joining hackathons means learning faster, building a strong portfolio, and standing out in placements.
24+

0 commit comments

Comments
 (0)