👨‍💻 Portfolio Website

This is my custom portfolio website made using HTML, CSS and JavaScript.

The website is deployed to GitHub Pages and can be found here.

Prerequisites

• Git
• NodeJs

How to start?

Install and develop on local machine

To run the project locally on your computer please clone the project using this command git clone and run npm install to install all required dependencies.

This Project uses ESLint and Prettier.

Due the project only uses HTML, CSS and JavaScript you can access the website on you local machine by opening the index.html-file with your favorite browser or by running npm start.

Automated tests and formatter

Before you submit a pull request you can run the tests with npm test. This will run all tests and will show you all the errors. The tests were written in cucumber and cypress.

Further you should run the formatter with npm run format.

Add another project to the website

The projects shown on the website are being accessed through the GitHub API and can be maintained by modifing the scripts.js.

let githubprojects = [
  {
    name: 'schmelto/100-days-of-code',
    icon: 'description',
  },
];

• name: username/repository (GitHub)
• icon: icon you want to display for the project (using Google Font Icons)

Due to lots of projects using icons in their project description the script in js/scripts.js remove the github icons.

project.description.replace(/:[^}]*:/, '');

Contribute

If you want to contribute to this project and make it better, your help is very welcome.

Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Check out one of our issues.

Code of Conduct

Help us keep this project open and inclusive. Please read and follow our Code of Conduct.

Love this project? Consider giving it a ⭐