davidsaulrodriguez / showcase

Use your GitHub username and personal contact information to dynamically build a simple and beautiful GitHub Profile that Showcases your latest repositories.

Showcase

The GitHub Profile Showcaser!

Introduction

A free service to help you create a beautiful and interactive way to display your GitHub profile easily using the GitHub Rest API. You can even have a little fun and get a random cat fact from both the Front page and from one of our themes!

User Story

I want an easy way to build beautiful developer profile pages and show off the latest repositories that a user has created and/or worked on simply by using their GitHub username.

Live Deployment

https://showcase.bsdadm.com

Screenshots

The MaterializeCSS Framework

For CSS we've decided to use MaterializeCSS as it is light weight, gets out of the way and makes for a stuningly beautiful, yet simple website that is mobile first and helps bring the project to life.

We use both vanilla JavaScript and jQuery.

For added functionality we are using both vanilla JavaScript and jQuery to keep our codebase light and efficent.

Team Roles

• Front-End (HTML/CSS Focused)
  • Alexander Marzullo (@Amarz94)
  • Drew Bridgman (@dbridgman1)
  • Michael Conway (@Mconway409)
  • David Rodriguez (@davidsaulrodriguez)*
• Backend (JavaScript & jQuery Focused)
  • David Rodriguez (@davidsaulrodriguez)

* Interim role and only step in when support is needed.

Bugs and Issues

Found a bug? Review any open issues or create a new issues here so we can fix it for you!

License

This project and all of its source code is released and permissively licensed under the BSD 2 Clause license.

showcase's Issues

Project & Repo Rename Suggestion

As this is not completely a resume generator per-say, I suggest that this repo and the project itself be renamed. In a way, we are only showcasing a user's GitHub profile in a more appealing way than what GitHub offers. For this reason, I would suggest that this repo and the project itself be renamed to something like, Showcaser or more appropriately, GitHub Profile Showcaser.

I am not in marketing or great with creating project names, but I believe this is something that we can come up with before this project is on December 17th 2020.

Of course, after this project is presented we can continue to work on and evolve it to become a true resume generator as well. But as of right now, with the current state of the project I believe it should be renamed to something more appropriate and fitting towards its current functionality.

@Amarz94, @Mconway409, @dbridgman1 - Feel free to chime in on this, leaving your comments and remarks on this issue and let me know what you all think about this suggestion.

Update README.md

The README.md file needs to be updated to reflect the changes made to the project as a whole.

• Update the Project Name
• Update the Project Description
• Update the Screenshot(s)
• Update the User Story
• Update the CSS Framework Description
• Update the Introduction AND
• Update the hyperlinks.
• Update the Live Site URL