Skip to content

Commit 3d35276

Browse files
authored
add web pages
2 parents 617c3fa + a7882fd commit 3d35276

140 files changed

Lines changed: 7627 additions & 0 deletions

File tree

Some content is hidden

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

.github/workflows/deploy.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master # Set this to your default branch name (e.g., main or master)
7+
workflow_dispatch: # Allows manual triggering from the GitHub UI
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
deploy:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
with:
18+
fetch-depth: 0
19+
20+
- name: Set up Python
21+
uses: actions/setup-python@v4
22+
with:
23+
python-version: "3.10"
24+
25+
- name: Install dependencies
26+
run: |
27+
python -m pip install --upgrade pip
28+
pip install mkdocs-material
29+
pip install pillow cairosvg
30+
31+
- name: Deploy MkDocs
32+
run: |
33+
mkdocs gh-deploy --force

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
11
.idea/
2+
site/
3+
__pycache__/
4+
*.py[cod]
5+
*$py.class
6+
.DS_Store
7+
.env
8+
.venv
9+
env/
10+
venv/
11+
ENV/

docs/about.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# About This Project
2+
3+
## Origin of the Content
4+
5+
This website is based on the "Grokking the Object Oriented Design Interview" course from [Educative.io](https://www.educative.io/courses/grokking-the-object-oriented-design-interview), enhanced with additional code examples and improved navigation.
6+
7+
The original repository contains:
8+
9+
1. **Object-Oriented Design and UML**: Theoretical foundation materials
10+
2. **Object-Oriented Design Case Studies**: 16 practical system design examples
11+
3. **Example codes**: Python implementation examples for each system
12+
4. **Media files**: Diagrams, UML charts, and visual assets
13+
14+
## Technology Used
15+
16+
This website is built using:
17+
18+
- **[MkDocs](https://www.mkdocs.org/)**: A fast, simple static site generator
19+
- **[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)**: A beautiful theme with enhanced features
20+
- **[Python](https://www.python.org/)**: All code examples are implemented in Python
21+
22+
## How to Use This Resource
23+
24+
1. **Learn Systematically**: Start with the OOP fundamentals and UML section before diving into case studies
25+
2. **Practice Actively**: Try to design the systems yourself before looking at the provided solutions
26+
3. **Study the Code**: Examine the Python implementations to understand how the designs translate to code
27+
4. **Apply the Methodology**: Use the same systematic approach for your own interview preparation
28+
29+
## Contributing
30+
31+
If you find any issues or have suggestions for improvement, please feel free to contribute by:
32+
33+
1. Opening an issue on GitHub
34+
2. Submitting a pull request with your proposed changes
35+
3. Suggesting additional case studies or improvements to existing ones
36+
37+
## Acknowledgements
38+
39+
Special thanks to:
40+
41+
- **Educative.io** for the original course content
42+
- **Contributors** who have helped enhance the material
43+
- **The open-source community** for providing the tools used to build this site
44+
45+
## Disclaimer
46+
47+
This website is intended for educational purposes only. The content is designed to help with interview preparation and learning object-oriented design principles.

docs/assets/images/activity-diagrams.svg

Lines changed: 2 additions & 0 deletions
Loading
43.1 KB
Loading

docs/assets/images/amazon.jpg

778 KB
Loading

docs/assets/images/ams-cancel-reservation-activity-diagram.svg

Lines changed: 2 additions & 0 deletions
Loading
313 KB
Loading

docs/assets/images/ams-reserve-ticket-activity-diagram.svg

Lines changed: 2 additions & 0 deletions
Loading

docs/assets/images/ams-uml.svg

Lines changed: 2 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)