GitHub - stevenplatt/ResearchEng-Portfolio: A html portfolio website template for research engineers.

An html portfolio website template for Research Engineers.

Demo Link: https://demo.telecomsteve.com

ResearchEng Portfolio is a portfolio template designed to be fast and easy to maintain. It includes a section for research, which is often not included in standard developer portfolio templates.

Features

Lightweight, responsive design
Research section for publications and academic work
Portfolio section for showcasing projects
Mobile-friendly with hamburger menu
Fast load times with minimal external dependencies
Easy to deploy on cloud storage

Demo

Check out the live demo at https://demo.telecomsteve.com

Development Environment

Using Dev Container

This project includes a dev container configuration that provides a consistent development environment with all necessary dependencies pre-installed.

To use the dev container:

Ensure you have Docker and VS Code with the Remote - Containers extension installed
Open the project in VS Code
When prompted, click "Reopen in Container" or use the command palette (F1) and select "Remote-Containers: Reopen in Container"
The container will build and install all dependencies automatically

The dev container includes:

Node.js 18
Python 3.11
http-server for local development
Useful VS Code extensions for web development

Manual Setup

If you prefer not to use the dev container, you can set up manually:

# Install http-server globally
npm install http-server -g

# Clone the repository
git clone https://github.com/stevenplatt/ResearchEng-portfolio.git

# Navigate to project directory
cd ResearchEng-portfolio/

Using the Makefile

The project includes a Makefile to simplify common development tasks:

# View all available commands
make help

# Install dependencies
make install

# Start local development server for the main template
make demo

# Start local development server for the telecomsteve example
make telecomsteve

# Clean temporary files
make clean

# Deploy to demo environment (requires GCP credentials)
make deploy-demo

# Deploy to production environment (requires GCP credentials)
make deploy-telecomsteve

Page Layouts

Desktop Page Layouts

About Page

Resume Page

Research Page

Portfolio Page

Blog Page

Blog Post Page

Mobile Page Layouts

All pages of the ResearchEng website template are also optimized for mobile.

Performance

Google Page Speed Index: 100/100

For both desktop and mobile.

Deployment

The site is designed to be served directly from object storage such as Amazon S3 but can also be deployed using Apache, Nginx, or other web servers. Example instructions for serving a website from Amazon S3 can be found here.

The project includes a GitHub Actions workflow for automated deployment to Google Cloud Storage.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/stevenplatt/ResearchEng-portfolio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The theme is available as open source under the terms of the MIT License.

Table of Contents