Skip to content

tanishabisht/Portfolio-Parallax

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Parallax themed personal website

Portfolio template - parallax theme

Who is this portfolio website for?

It's perfect for developers seeking to showcase their work in a dynamic, engaging manner that captures the attention of visitors. The inclusion of an Automated Email feature for quick contact ensures that potential clients or collaborators can easily reach out, enhancing the site’s functionality and user engagement.

Style of the Website

The "Interactive Parallax" theme capitalizes on the captivating parallax effect, paired with a squared responsive background that enhances user interaction and visual depth.

Font Choice: Montserrat

Color Choices: Black, White and Gray

How to Customize and Deploy Your Project

Step 1: Fork the Repository

Begin by forking the repository to create a personal copy under your GitHub account.

Step 2: Clone Your Fork

Clone the forked repository to your local machine. Replace (username) with your GitHub username and (newreponame) with the name of the repository.

git clone [email protected]:(username)/(newreponame).git

Step 3: Set Up Your Project

Navigate to the project directory:

cd (newreponame)

Switch to the appropriate Node.js version using nvm:

nvm install v16.20.2
nvm use v16.20.2

Step 4: Install Dependencies

Install the necessary project dependencies:

npm install --force

Step 5: Start the Development Server

Launch the development server which will host the project on your local machine:

npm start
  • The server will be accessible at localhost:3000.

Step 6: Customize Your Project

Make necessary changes to personalize the project:

  • Modify the content in the website by editing the variables in the file located at variables.js.

Step 7: Update Repository Configuration

Change the repository URL in package.json to match your GitHub Pages URL:

"https://(username).github.io/(newreponame)"

Replace (username) with your GitHub username and (newreponame) with your repository name.

Step 8: Deploy Your Changes

Deploy your updated website to GitHub Pages:

npm run deploy

Step 9: Configure GitHub Pages

  • Navigate to your repository on GitHub.
  • Go to Settings > Pages.
  • Set the GitHub Pages source to deploy from the gh-pages branch and select the /(root) folder.
  • Click Save.

Step 10: Access Your Deployed Site

  • Your website will be available shortly after deployment.
  • Access it via https://(username).github.io/(newreponame).

Follow these steps to customize and deploy your project effectively on GitHub Pages, ensuring it reflects your personal style and preferences.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.