-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Upcase env vars and add codeship badge
- Loading branch information
Showing
11 changed files
with
44 additions
and
16 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 |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# CodePraise | ||
|
||
Web API for the CodePraise application | ||
|
||
[ ![Codeship Status for soumyaray/code_praise](https://app.codeship.com/projects/b454db90-a9c0-0135-3b68-622b0705736a/status?branch=master)](https://app.codeship.com/projects/256400) | ||
--- | ||
|
||
## Routes | ||
|
||
Our API is rooted at `/api/v0.1/` and has the following subroutes: | ||
- `GET repo` – Index of all repos stored | ||
- `GET repo/ownername/reponame` - Fetch metadata of a previously stored repo | ||
- `POST repo/ownername/reponame` - Load a repo from Github and store metadata in API | ||
|
||
## Setup | ||
|
||
To setup and test this API on your own machine: | ||
|
||
``` | ||
$ git clone [email protected]:soumyaray/code_praise.git | ||
$ cd code_praise | ||
$ bundle install | ||
$ bundle exec rake db:migrate | ||
$ RACK_ENV=test bundle exec rake db:migrate | ||
$ bundle exec rake spec | ||
``` | ||
|
||
You may have to add your Github developer token to `config/secrets.yml` (see example in folder) |
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
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,8 +1,8 @@ | ||
--- | ||
development: | ||
db_filename: infrastructure/database/dev.db | ||
repostore_path: infrastructure/gitrepo/repostore | ||
DB_FILENAME: infrastructure/database/dev.db | ||
REPOSTORE_PATH: infrastructure/gitrepo/repostore | ||
|
||
test: | ||
db_filename: infrastructure/database/test.db | ||
repostore_path: infrastructure/gitrepo/repostore | ||
DB_FILENAME: infrastructure/database/test.db | ||
REPOSTORE_PATH: infrastructure/gitrepo/repostore |
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
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,6 +1,6 @@ | ||
--- | ||
development: | ||
gh_token: <personal token for Github API> | ||
GH_TOKEN: <personal token for Github API> | ||
|
||
test: | ||
gh_token: <personal token for Github API> | ||
GH_TOKEN: <personal token for Github API> |
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
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
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
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
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
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