Giter Club home page Giter Club logo

gitshowcase's Introduction

GitShowcase

Code Climate Build Status standard-readme compliant

Get noticed with a rockstar Portfolio

GitShowcase exists to help developers to present their awesomeness, showing their skills, projects and social networks in a way that is easy to understand.

Contact us @ [email protected]

Table of Contents

Install

System Requirements

  • Ruby 2.4.0 recommended
  • Postgres 9.2+
  • NodeJS (for compiling javascript resources)

Fork and bundle

  • Fork the project
  • Run bundle to install gems
bundle install

Create your GitHub application

Unless you only want to edit the homepage, you'll need your own GitHub credentials for development.

Go to your settings, than OAuth applications and register a new application.

For Authorization callback URL field, use: http://localhost:3000/users/auth/github/callback. The other fields (name, description) may be filled at your will.

Configure your environment

Copy the file .env.example to .env and fill the fields

DB_USERNAME=
DB_PASSWORD=

APP_DOMAIN=localhost

GITHUB_KEY=
GITHUB_SECRET=

If you're using Linux or OSX, you probably don't need to fill the DB_ fields

Database setup

Download and Install Postgres

  • Create the databases:
rails db:create
  • Run migrations to create tables:
rails db:migrate
  • Seeding:
rails db:seed

Redis setup

Redis is used for managing queues inside the application.

For more information about how to install Redis, please refer to https://redis.io/topics/quickstart

Running Tests

To run the tests, use:

bundle exec rspec

Running Server

Start Rails, Redis and Sidekiq.

rails s
redis-server
bundle exec sidekiq

Road map

We have a road map of what we are going to implement next. It is available at our projects page

https://github.com/gitshowcase/gitshowcase/projects

If you wish to add features that are not on the road map, you're very welcome to do so. We encourage you to create an Issue before coding, so we can all discuss the relevance to the community.

Please keep in mind that the focus is to create a great product, so we might not implement/accept all the suggested features.

Maintainers

Pedro Moreira (Developer) - https://www.gitshowcase.com/pedsmoreira

Victor Hunter (UI/UX) - https://www.gitshowcase.com/victorgaard

Contribute

All contributions must be written in English, so everyone can communicate :)

Feel free to Open an issue or submit PRs. If you choose to open a PR, please do so on the development branch.

GitShowcase follows the Contributor Covenant Code of Conduct.

Code Style

TODO - Add code styling (Rubocop) to Travis CI

Code Quality

The Pull Request must not present issues on Code Climate.

Commit Messages

Commit messages should be verb based, such as:

  • Fixing ...
  • Adding ...
  • Updating ...
  • Removing ...

Tests

Please update the tests to reflect your changes.

Travis CI will run on your PR and it has to pass for the PR to be accepted :)

License

gitshowcase.com/license

gitshowcase's People

Contributors

emma-sg avatar jaimerson avatar jonatasrancan avatar larkinscott avatar matias-eduardo avatar pedsmoreira avatar victorgaard avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

gitshowcase's Issues

Feature Print Style

Currently this is so
screen shot 2017-03-01 at 11 26 44

When I use command + p, to print my showcase the formatting is broken I would suggest a resume format

Global stats

Um Ranking das linguagens com mais projetos dentro do gitshowcase na home.

Follow github button

Ter o botão de seguir(no github) no perfil.
--- Translation ---
Add the Follow on GitHub button to profile page.

Dockerizing the project

I love gitshowcase. I think it is an amazing project. I want to contribute to it.
My problem is I don't know ruby. I am just trying my polyglot skills.

Setting up ruby seems to be a pain with all the versions environments and so on. I don't know if it's just me.

But What does it take to dockerizing the project?

Display stars and forks on projects

Display stars and forks on projects

screen shot 2017-03-16 at 1 32 12 am

Such as
screen shot 2017-03-16 at 1 47 39 am

I am not familiar with the stack you use, but in the frontend, the below code in footer would do the work

obviously the values for star and fork is mocked data, it should be dynamically populated for each project card

<footer class="container-fluid">
   <div class="pull-left">
       <span class="project-language label label-default"><i class="fa fa-code"></i> Java</span> &nbsp; 
       <span class="project-language label label-default"><i class="fa fa-star"></i> 1.7k</span> &nbsp; 
       <span class="project-language label label-default"><i class="fa fa-code-fork"></i> 151</span> 
   </div>
   <a class="project-repository" href="https://github.com/username/project-name" rel="nofollow" target="_blank"><i class="fa fa-github"></i> Repository</a>
</footer>

Reconsider skill measurement

I often see people discouraging the use of elements such as stars or progress bars to measure skill.

  • Selecting all five stars would give the idea that you know everything there's to know about the subject;
  • Selecting few of them seems to point out that you're poorly skilled or unfamiliar with the technology (so it shouldn't be on the portifolio);

My suggestion then is to use something that gives a better idea of the developer's experience. Maybe displaying the total percentage of technologies (kinda like GitHub does) or the time spent developing with them.

could not connect to server

could not connect to server: No such file or directory Is the server running locally and accepting connections on Unix domain socket "/tmp/.s.PGSQL.5432"?

How do I resolve this locally?.

ou are setting a key that conflicts with a built-in method OmniAuth::AuthHash::InfoHash#name defined at /Users/kirbyjames/.rvm/gems/ruby-2.3.3/gems/omniauth-1.3.2/lib/omniauth/auth_hash.rb:34. This can cause unexpected behavior when accessing the key via as a property. You can still access the key via the #[] method.
could not connect to server: No such file or directory
	Is the server running locally and accepting
	connections on Unix domain socket "/tmp/.s.PGSQL.5432"?
Couldn't create database for {"adapter"=>"postgresql", "encoding"=>"unicode", "pool"=>5, "username"=>nil, "password"=>nil, "database"=>"gitshowcase_development"}
rails aborted!
PG::ConnectionBad: could not connect to server: No such file or directory
	Is the server running locally and accepting
	connections on Unix domain socket "/tmp/.s.PGSQL.5432"?

If more than 10 skills are added they get pushed too far to the right.

When more than 10 skills are added they get pushed too far to the right seemingly cutting them off because the text and stars are white on top of the light gray and white background colors. As a result of the page extending too far to the right, a horizontal scroll bar also appears.

Maybe a limit could be set to only allow 10 skills given the amount of space that keeps the web design clean, or skills that go past 10 could be added to the bottom, or the overall text could be smaller? Anyway, just wanted to make this issue known / see if others are having the same problem.

Delete my page

This tool is dumb. I don't want a page on there with my name on it.

http://www.gitshowcase.com/thejaredwilcurt

Also. Add a "delete my portfolio" button.

Edit: I did not cross out the statement "This tool is dumb." That censorship was done by the repo owners, not me. I still firmly believe this tool, which does not have a delete button for accounts, uses arbitrary star ratings for ones qualifications without any metrics associated, and defaults to repos and thumbnails that make no sense , is dumb.

Also, censorship is wrong.

All projects not diplayed

Firstly, thanks for this great project 🥇 This is helpful for a lot of people, IMO.

Description

  • While selecting the projects, all of my public projects are not displayed in the list.
  • I noticed that there is an option to manually add projects, but that seems really uncomfortable when one has many projects in other organizations. I think the Github API can be used for accessing the projects in those orgs too.
  • I understand that maybe displaying all of the projects can be messy, but maybe it would be better to display the projects after sorting them by stars, what do you think?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.