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! π
Check out the live demo to see it in action:
π Live Preview
- 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.
β¨How to Fork
- Click the Fork button at the top right of this repository.
- 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
- Navigate to the project directory:
cd simonprovost.dev
π₯ Steps to Install & Deploy to Vercel
-
Install Dependencies
Run the following command to install all required packages:npm install # or yarn install
-
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.
-
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/
-
Here's a detailed breakdown of the project's structure:
- 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.
- 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.
- 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.
- Configuration Files π οΈ
- Centralises all screen configurations for quick modifications without changing the core code. One config per screen.
To customise the project:
- Public Assets: Add or modify images, animations, and videos in the
Public
folder. - Components: Update or create new components in the
src/Components
directory. - Screens: Customise each screen by editing files in the
src/Screens
directory. - Configs: Adjust configurations in the
Configs
folder to change screen settings without altering the codebase.
- Scholar Profile Integration π:
- Automatically fetch Scholar profiles, abstracts, and authors for the research screen, eliminating the need for manual configuration.
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.
This project is licensed under the MIT License.
Inspired by Nelson and built with Create React App.
# 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
π