Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gitshowcase/gitshowcase
Awesome Portfolio from your Github
https://github.com/gitshowcase/gitshowcase
developer github github-integration portfolio
Last synced: about 2 months ago
JSON representation
Awesome Portfolio from your Github
- Host: GitHub
- URL: https://github.com/gitshowcase/gitshowcase
- Owner: gitshowcase
- Created: 2017-01-09T02:52:31.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-16T21:03:37.000Z (almost 7 years ago)
- Last Synced: 2024-08-13T07:15:44.602Z (6 months ago)
- Topics: developer, github, github-integration, portfolio
- Language: Ruby
- Homepage: https://www.gitshowcase.com
- Size: 4.69 MB
- Stars: 239
- Watchers: 10
- Forks: 26
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - gitshowcase/gitshowcase - Awesome Portfolio from your Github (Ruby)
README
# GitShowcase
[](https://codeclimate.com/github/gitshowcase/gitshowcase)
[](https://travis-ci.org/gitshowcase/gitshowcase)
[](https://github.com/RichardLitt/standard-readme)
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]](mailto:[email protected])
# Table of Contents
- [Install](#install)
- [Road map](#road-map)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#license)
## Install
### System Requirements
- Ruby `2.4.0` recommended
- Postgres 9.2+
- [NodeJS](https://nodejs.org/) _(for compiling javascript resources)_
### Fork and bundle
- Fork the project
- Run bundle to install gems
```bash
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](https://github.com/settings/developers) 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
```bash
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](https://www.postgresql.org/download/)
- Create the databases:
```bash
rails db:create
```
- Run migrations to create tables:
```bash
rails db:migrate
```
- Seeding:
```bash
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](https://redis.io/topics/quickstart)
### Running Tests
To run the tests, use:
```bash
bundle exec rspec
```
### Running Server
Start Rails, Redis and Sidekiq.
```bash
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](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](https://github.com/gitshowcase/gitshowcase/issues/new)
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](https://www.gitshowcase.com/pedsmoreira)
Victor Hunter _(UI/UX)_ - [https://www.gitshowcase.com/victorgaard](https://www.gitshowcase.com/victorgaard)
## Contribute
All contributions must be written in *English*, so everyone can communicate :)
Feel free to [Open an issue](https://github.com/gitshowcase/gitshowcase/issues/new) or submit PRs. If you choose
to open a PR, please do so on the `development` branch.
GitShowcase follows the [Contributor Covenant](http://contributor-covenant.org/version/1/4) 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](http://gitshowcase.com/license)