Academic Portfolio Website Readme

Live Demo

by Subham Shome

Welcome to my personal academic portfolio website! This README will guide you through the structure, features, and how to set up and customize this website to showcase your academic achievements and accomplishments.

Table of Contents:

1. Introduction
2. Getting Started
3. Structure
4. Deployment
5. Contact

1. Introduction

This academic portfolio website is designed to help you showcase your academic journey, research projects, publications, and personal achievements. It is a simple, yet elegant, website that allows you to present your accomplishments in an organized and visually appealing manner.

2. Getting Started

To set up your own academic portfolio website, follow these steps:

1. Fork this repository: Start by forking this repository to create a copy in your own GitHub account.
2. Clone the repository: Clone the forked repository to your local machine using Git: git clone https://github.com/subhamshome/portfolio.git
3. Navigate to the project directory:cd portfolio

Customize the content: Update the content, such as your name, bio, academic history, research projects, by editing the HTML and Markdown files in the content directory.

Configure the settings: Customize the website by modifying the settings in the config.js file, such as the site title, social media links, and color schemes.

Preview your site: To see how your site looks locally, you can use a simple web server or a development tool like Live Server for Visual Studio Code.

Test and make additional changes: Review your website locally and make further adjustments as necessary.

3. Structure

The website's structure is organized as follows:

• public/index.html: The main page of your academic portfolio.
• src/app.js: The main entry point for the project.
• src/index.js: The main entry point for rendering the components.
• src/components/: Contains all the .jsx and .css files for rendering and styling.
• src/assets/: Houses all assets such as images and gifs.
• README.md: This file that provides instructions and information about the project.

4. Deployment

This website is deployed with the help of Vercel.

5. Contact

If you have any questions, need assistance, or want to contribute to this project, please don't hesitate to contact me.

Email: ss3038@hw.ac.uk
GitHub: https://github.com/subhamshome

If you are using this website as a template, please mention this repository as the reference repo. Thank you for using this academic portfolio template. Best of luck with showcasing your academic journey and accomplishments!