Skip to content

About

Welcome to the GitHub repository for adamdjellouli.com. Your feedback, comments, and suggestions for improvements are highly appreciated. Your support is invaluable to me.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

Β 

History

988 Commits

Folders and files

Repository files navigation

Personal Website

Netlify Status License: MIT Maintenance Website

Welcome to the GitHub repository for adamdjellouli.com! This is the source code for my personal website where I share my thoughts, projects, and various topics of interest. Your feedback, comments, and suggestions for improvements are highly appreciated.

πŸ“– Overview

This repository hosts the code for my personal website. It's a space where I share my thoughts, projects, and various topics that spark my interest. The site is meticulously crafted using HTML, CSS, and TypeScript, augmented with custom Python scripts that generate most of the content and update common elements across pages.

🌐 Live Demo

Check out the live website: adamdjellouli.com

πŸ–ΌοΈ Screenshot

A glimpse of adamdjellouli.com

πŸ“‘ Table of Contents

πŸ’‘ Philosophy

  • Dedication to Originality: No use of boilerplates, templates, or frameworks.
  • From Scratch: Building everything from the ground up with HTML, CSS, and TypeScript.
  • Automation: Regular updates to all common page elements through custom Python scripts for consistency and efficiency.

πŸ› οΈ Building Blocks

The website consists of these fundamental components:

HTML Elements

  • Header
  • Navigation Bar
  • Footer
  • Main Content Section
  • Individual Article Pages

CSS Files

  • General Components
  • Navigation Bar Styling
  • Footer Styling

πŸ”§ Technologies

This project employs the following technologies:

πŸš€ Getting Started

Follow these instructions to set up the project on your local machine for development and testing purposes.

Prerequisites

Ensure you have the following installed on your system:

  • Node.js (version 14.x or higher)
  • npm (usually comes with Node.js)
  • Python 3 (version 3.7 or higher)
  • pip (Python package manager)

You can verify your installations by running:

node --version
npm --version
python3 --version
pip3 --version

Installation

Follow these steps to get your development environment set up:

  1. Clone the repository
git clone https://github.com/djeada/Personal-Website.git
cd Personal-Website
  1. Install Python dependencies
cd scripts
pip3 install -r requirements.txt
cd ..
  1. Run Build Scripts

Execute the main build script to generate the website:

cd scripts
python3 run_all.py
cd ..

The generated website files will be available in the output directory, ready for deployment or local testing.

  1. View the website locally (optional)

You can use any local web server to view the generated site. For example, using Python's built-in HTTP server:

cd src
python3 -m http.server 8000

Then open your browser and navigate to http://localhost:8000

πŸ“œ Scripts

This directory contains a set of Python scripts designed to build and maintain the personal website. Each script serves a specific purpose in the process of converting content, styling, and organizing the website's structure.

Script Descriptions

Script Description
apply_common_elements.py Integrates common elements (like headers and footers) across all HTML files in the website, ensuring consistency in design and navigation.
bundle_css.py Consolidates multiple CSS files from the resources/assets directory into a single style.css file. This improves page load times by reducing the number of HTTP requests.
clean_output_dirs.py Cleans and prepares output directories, ensuring a fresh environment for each build process.
create_site_map.py Generates a sitemap of the website, which is crucial for SEO and helps search engines index the site more effectively.
format.sh A shell script to format and lint code, maintaining code quality and consistency throughout the project.
generate_article_list.py Compiles a list of all articles or blog posts rendered on a specific section of the website (blog).
generate_from_markdown.py Converts Markdown files, primarily used for the blog section, into HTML format for web presentation.
generate_quizzes.py / generate_flashcards.py Validate the quizzes and flashcards kept in the notes repositories and build the JSON for the quiz and flashcard tools (--local-root, --check, --strict).
generate_related_articles_section.py Creates a section on each article page that suggests related articles, enhancing user engagement.
generate_table_of_contents.py Produces a table of contents for articles, making longer content more navigable.
get_markdown_urls.py Extracts and lists URLs from Markdown files, which are sources from which the articles will be generated.
run_all.py A comprehensive script that executes all the above scripts in the required sequence. It acts as a one-click solution to rebuild or update the entire website.

Usage

To run the entire website building process, execute:

cd scripts
python3 run_all.py

Alternatively, individual scripts can be run separately for specific tasks as needed. For example:

# Generate sitemap only
python3 create_site_map.py

# Bundle CSS files only
python3 bundle_css.py

# Generate articles from Markdown
python3 generate_from_markdown.py

🀝 Contributing

We encourage contributions that enhance the repository's value. To contribute:

  1. Fork the repository

  2. Create your feature branch

git checkout -b feature/AmazingFeature
  1. Commit your changes
git commit -m 'Add some AmazingFeature'
  1. Push to the branch
git push origin feature/AmazingFeature
  1. Open a Pull Request

Please ensure your code follows the existing style and all tests pass before submitting a pull request.

πŸ“ Project Structure

Personal-Website/
β”œβ”€β”€ images/              # Image assets
β”œβ”€β”€ scripts/             # Build and maintenance scripts
β”‚   β”œβ”€β”€ apply_common_elements.py
β”‚   β”œβ”€β”€ bundle_css.py
β”‚   β”œβ”€β”€ generate_from_markdown.py
β”‚   β”œβ”€β”€ run_all.py
β”‚   └── ...
β”œβ”€β”€ src/                 # Source files for the website
β”‚   β”œβ”€β”€ articles/        # Article HTML files
β”‚   β”œβ”€β”€ building_blocks/ # Common HTML elements (header, footer)
β”‚   β”œβ”€β”€ core/            # Core pages (about, blog, projects)
β”‚   └── tools/           # Interactive tools
β”œβ”€β”€ .gitignore
β”œβ”€β”€ LICENSE
└── README.md

πŸ”§ Troubleshooting

Common Issues

Issue: Python scripts fail with module import errors

Solution: Ensure all dependencies are installed:

cd scripts
pip3 install -r requirements.txt

Issue: Generated website doesn't display correctly

Solution: Make sure you've run the complete build process:

cd scripts
python3 run_all.py

Issue: Netlify deployment fails

Solution: Check the Netlify badge status above and review the deployment logs in your Netlify dashboard.

Getting Help

If you encounter any issues not listed here, please open an issue on GitHub.

πŸ—ΊοΈ Roadmap

  • Basic website structure with HTML/CSS/TypeScript
  • Automated build scripts in Python
  • Blog section with Markdown support
  • Responsive design
  • SEO optimization with sitemap
  • Dark mode support
  • Improved accessibility features
  • Performance optimization
  • Multi-language support

See the open issues for a full list of proposed features and known issues.

πŸ™ Acknowledgments

  • Thanks to all contributors who have helped improve this project
  • Inspired by the philosophy of building from scratch without frameworks
  • Built with love for the web development community

πŸ“§ Contact

Adam Djellouli - @djeada

Project Link: https://github.com/djeada/Personal-Website

Website: adamdjellouli.com

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Welcome to the GitHub repository for adamdjellouli.com. Your feedback, comments, and suggestions for improvements are highly appreciated. Your support is invaluable to me.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages