Prerequisites 📋

You'll need Git and Node.js (which comes with NPM) installed on your computer.

[email protected] or higher
[email protected] or higher
[email protected] or higher

Also, you can use Yarn instead of NPM ☝️

[email protected] or higher

---

How To Use 🔧

From your command line, first clone Simplefolio:

# 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

After that, you can install the dependencies either using NPM or Yarn.

Using NPM: Simply run the below commands.

# 2022 Update - Fix Dependencies
$ npm audit fix
$ npm i @parcel/transformer-sass

# Install dependencies
$ npm install

# Start the development server
$ npm start

Using Yarn: Be aware of that you'll need to delete the package-lock.json file before executing the below commands.

# Install dependencies
$ yarn

# Start the development server
$ yarn start

NOTE: If your run into issues installing the dependencies with NPM, use this below command:

# Install dependencies with all permissions
$ sudo npm install --unsafe-perm=true --allow-root

Once your server has started, go to this url http://localhost:1234/ to see the portfolio locally. It should look like the below screenshot.