Follow the steps below to set up and run your portfolio locally.
# Clone the repository
git clone https://github.com/cobiwave/simplefolio
# Move into the repository
cd simplefolio
# Remove the current origin repository
git remote remove origin
You can use either NPM or Yarn to install dependencies.
# 2022 Update - Fix Dependencies
npm audit fix
npm i @parcel/transformer-sass
# Install dependencies
npm install
# Start the development server
npm start
Before running the commands, delete the package-lock.json
file.
# Install dependencies
yarn
# Start the development server
yarn start
If you run into issues installing dependencies with NPM, use the following command:
# Install dependencies with all permissions
sudo npm install --unsafe-perm=true --allow-root
Once the development server is running, open the following URL in your browser:
http://localhost:1234/
Your portfolio should now be visible.
You can customize the portfolio by modifying the files in the src/
directory. Update the content, styles, and configurations as per your preferences.
To deploy your portfolio on GitHub Pages:
- Build the project:
npm run build
- Deploy the build folder using GitHub Pages or any hosting service of your choice.
This project is open-source and available under the MIT License.
Happy coding! 🚀