enterstudio / git-gallery Goto Github PK

Description

This is a Flatiron student project. This site is a portfolio site for developers where they are able to log in using Github Authentication. In doing so, it reads and brings in personal repos where they are able to create a project. After creating a project, the developer will be able to create features about units of code, and explain the feature through code snippets, descriptions and screenshots.

Gems and Environment

Gem Usage

• carrierwave to upload images
• pygments.rb to highlight syntax for code snippets
• omniauth-github for authorization and sigin through github
• best_in_place for inline field editing
• client_side_validations for form validations
• debugger for debuggin!
• better_errors and binding_of_caller for a nice interface for error reporting
• therubyracer embedding ruby in javascript
• mail using this for a mail interceptor in development

Instructions

• clone Git Gallery Repo

git clone [email protected]:flatiron-school/git-gallery.git

• bundle install
• configure your database.yml.sample file (in the config directory) to set up your databases.
• remember to rename the file and remove the .sample from the file name.
• create your database with the following command:

rake db:migrate

Github Application Registration

• when you are signed in Github click this link and register your application to be able use the Github API.

This application uses the Github API for the following purposes:

• user authentication
• user information includeing github id, username, and email
• pulls repo list and repo information

Once the account is created you will need to assign the KEY and SECRET for your app.

• start your server

rails s