forked from github/platform-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9250a85
commit 6780a09
Showing
3 changed files
with
40 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,13 @@ | ||
platform-samples | ||
================ | ||
|
||
A public place for all platform sample projects. | ||
This is a public place for all sample projects related to the GitHub Platform. | ||
|
||
Will be open-source and public when it's good and ready. The goal is to have | ||
people clone the repo, and get started easily. | ||
## Hierarchy | ||
|
||
The directories are organized to correlate with guides found on developer.github.com. | ||
But here it is, broken down: | ||
|
||
* _api_: here's a bunch of sample code relating to the API. Subdirectories in this | ||
category are broken up by language. Do you have a language sample you'd like added? | ||
Make a pull request and we'll consider it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
basics-of-authentication | ||
================ | ||
|
||
This is the sample projct built by following the "[Basics of Authentication][basics of auth]" | ||
guide on developer.github.com. | ||
|
||
It consists of two different servers: one built correctly, and one built less optimally. | ||
|
||
To run these projects, make sure you have [Bundler][bundler] installed; then type | ||
`bundle install` on the command line. | ||
|
||
For the "less optimal" server, type `ruby server.rb` on the command line. | ||
This will run the server at `localhost:4567`. | ||
|
||
For the correct server, enter `rackup -p 4567` on the command line. | ||
|
||
[basics of auth]: http://developer.github.com/guides/basics-of-authentication/ | ||
[bundler]: http://gembundler.com/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
rendering-data-as-graphs | ||
================ | ||
|
||
This is the sample projct built by following the "[Rendering Data as Graphs][rendering data]" | ||
guide on developer.github.com. | ||
|
||
To run these projects, make sure you have [Bundler][bundler] installed; then type | ||
`bundle install` on the command line. | ||
|
||
Then, enter `rackup -p 4567` on the command line. | ||
|
||
[rendering data]: http://developer.github.com/guides/rendering-data-as-graphs/ | ||
[bundler]: http://gembundler.com/ |