/profileme-dev

Create an awesome GitHub profile in minutes

Primary LanguageJavaScript

ProfileMe.dev

ProfileMe.dev helps developers create an amazing GitHub profile in minutes.

Demo

A live version of this project can be found at https://www.profileme.dev.

Features

Users can easily build and customise their GitHub profile, working with the following:

  • Introduction section (to include basic information, links to portfolio and any current projects that are of note.)
  • Skills icons (with over 60 technologies and softwares available to choose from)
  • Socials links (with 18 social media platforms to choose from)
  • Badges and statistics (graphic elements to add to your profile, such as GitHub stats badges, Twitter follower counts and Twitch streaming status)
  • Links to support sites (such as BuyMeACoffee).

Tech Stack

This project was built with NextJS (built on React) and TailwindCSS, and is client-only (with no backend).

Installation

ProfileMe has a very simple, two-step installation process.

1. Install dependencies

npm install

2. Run development server

npm run dev

Contributing

Contributions are always welcome!

To get started, please take a look at the 'Issues' tab, where you will find open issues that exist with the project. If you see one that interests you, simply create a branch and submit a PR for review and approval.

License

ProfileMe is available under the GNU General Public License v3.0 license. Please read the terms of this license before making modification or amendments to the source code or any of its assets.