Skip to content

Come check out my personal website! You can also fork the template! πŸ‘€

License

Notifications You must be signed in to change notification settings

simonprovost/simonprovost.dev

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

32 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Cover Image GitHub Repo stars GitHub forks GitHub issues GitHub pull requests Last Commit License Website Deploy


πŸš€ Minimalist Academia Portfolio Template

Welcome to my crafted from scratch Personal Portfolio & Academic Website Template! πŸŽ‰
Whether your work is academic, developer, or researcher, this simple yet
powerful template is meant to elegantly and effectively highlight your work.
Inspired by Nelson's elegant style, this template showcases your projects,
publications, and more with a clean, modern layout.

Feel free to fork this repository, modify it to fit your needs, and deploy your
personalised host with ease! πŸš€


🌟 Live Preview

Check out the live demo to see it in action:

πŸ”— Live Preview


πŸ“¦ Features

  • Minimalist Design πŸ–ŒοΈ: Clean and elegant layout to focus on your content.
  • Vercel Integration ⚑: Seamlessly deploy your site with Vercel.
  • Analytics πŸ“ˆ: Built-in Vercel Analytics and Speed Analytics.
  • Blog Integration πŸ“: Fetch blog posts directly from a public Notion database.
  • Interactive Animations 🎨: Engaging Rive animations for a dynamic user experience, including minimalist appearing animations and more.

🍴 Fork, Modify & Deploy

✨How to Fork
  1. Click the Fork button at the top right of this repository.
  2. Clone the forked repository to your local machine:
    git clone #the proposed link
    # e.g For me it would be: https://github.com/simonprovost/simonprovost.dev.git
  3. Navigate to the project directory:
    cd simonprovost.dev

πŸ› οΈ Installation & Setup

πŸ”§Prerequisites

Make sure you have the following installed:

πŸ“₯ Steps to Install & Deploy to Vercel
  1. Install Dependencies
    Run the following command to install all required packages:

    npm install
    # or
    yarn install
  2. Run the Development Server
    Start the development server:

    npm start
    # or
    yarn start

    Open http://localhost:3000 to view it in your browser.

    • The page will reload automatically when you make changes.
  3. Deploy to Vercel
    Deploy your application to Vercel in a few simple steps:

    • Install Vercel CLI (if not already installed):

      npm install -g vercel
    • Login to Vercel:
      Authenticate your Vercel account:

      vercel login
    • Deploy the Project:
      Run the following command to deploy your project:

      vercel
    • Follow the on-screen instructions to link your project to your Vercel account.

    • Production Deployment:
      To deploy in production mode, use:

      vercel --prod

    Your site will now be live, and Vercel will provide a deployment link like:
    https://yourprojectname.vercel.app/


πŸ“‚ Project Structure

Here's a detailed breakdown of the project's structure:

Public/

  • Images/ πŸ–ΌοΈ: Contains images used throughout the project.
  • rive/ 🎬: Holds Rive animation files (e.g., head tracking animations).
  • videos/ πŸŽ₯: Stores video assets used in the project.

src/

Components/

  • AcademiaHeader πŸŽ“
    • Displays a header, allowing users to mention their academic supervisor.
  • BlogPost πŸ“
    • Loads a specific blog post fetched via URL/ID.
  • PostList πŸ“š
    • Displays a list of posts (jobs/projects/papers) with titles, subtitles, and hover details.
  • RiveDownloadCV πŸ“„
    • Shows a book animation that downloads the CV when clicked.
  • RiveHeadTracking πŸ‘€
    • Displays the head-tracking animation.
  • RiveLoader ⏳
    • Shows a Rive-based loader animation.
  • SnakeEffect 🐍
    • Adds a blurry snake-like effect to children elements.
  • SocialsList πŸ”—
    • A minimalist list of social links without hover actions.

Screens/

  • About πŸ§‘β€πŸ«
    • Details your academic journey. (You may need to rewrite this page.)
  • Blog πŸ“°
    • Displays articles fetched from a Notion database. Fork mine here.
  • Connect 🀝
    • Shows connect links.
  • Credits πŸŽ–οΈ
    • Displays a spiral-based credits screen.
  • OpenSource 🌐
    • Showcases open-source projects with associated media.
  • Research πŸ”¬
    • Displays a list of papers with titles and abstracts on hover.

Configs/

  • Configuration Files πŸ› οΈ
    • Centralises all screen configurations for quick modifications without changing the core code. One config per screen.

πŸ” Modifying the Project

To customise the project:

  1. Public Assets: Add or modify images, animations, and videos in the Public folder.
  2. Components: Update or create new components in the src/Components directory.
  3. Screens: Customise each screen by editing files in the src/Screens directory.
  4. Configs: Adjust configurations in the Configs folder to change screen settings without altering the codebase.

πŸ› οΈ Future Enhancements

  • Scholar Profile Integration πŸ“š:
    • Automatically fetch Scholar profiles, abstracts, and authors for the research screen, eliminating the need for manual configuration.

🀝 Open Source Contributions

I love collaboration! 🌟 Share your ideas, provide enhancements, and contribute to making this template even better. Feel free to open issues or submit pull requests.

πŸŽ‰ Cheers!

Happy Building! πŸš€


πŸ“„ License

This project is licensed under the MIT License.


πŸ“š Reference

Inspired by Nelson and built with Create React App.


Quick Start

# Clone the repository
git clone https://github.com/simonprovost/simonprovost.dev.git

# Navigate to the project directory
cd simonprovost.dev

# Install dependencies
npm install
# or
yarn install

# Start the development server
npm start
# or
yarn start

πŸ‘€

About

Come check out my personal website! You can also fork the template! πŸ‘€

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published