https://github.com/mjmsmith/starredsearch
Search readmes in starred GitHub repos.
https://github.com/mjmsmith/starredsearch
github os-x readme search vapor
Last synced: 6 months ago
JSON representation
Search readmes in starred GitHub repos.
- Host: GitHub
- URL: https://github.com/mjmsmith/starredsearch
- Owner: mjmsmith
- License: mit
- Created: 2016-05-01T23:43:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-24T23:25:13.000Z (over 8 years ago)
- Last Synced: 2025-04-23T16:24:31.814Z (9 months ago)
- Topics: github, os-x, readme, search, vapor
- Language: Swift
- Size: 303 KB
- Stars: 36
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
**Starred Search** is a tool to search the readme files in GitHub users' starred repositories. It lives at [starredsearch.com](http://starredsearch.com).
The app is written in Swift using the [Vapor](https://github.com/qutheory/vapor) web framework.
# Prerequisites
* Swift 3 / Xcode 8.
* A [GitHub OAuth application](https://github.com/settings/developers) with the callback URL set to `/oauth/github` on your server.
# Debug Environment
Create the file `debug.json` in your checkout directory:
```
{
"GITHUB_CLIENT_ID": "",
"GITHUB_CLIENT_SECRET": "",
"APP_ADMIN_PASSWORD": ""
}
```
# Release Environment
Define environment variables for `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET` and `APP_ADMIN_PASSWORD`.
# Sample launchctl File
Replace `???` as appropriate.
```
EnvironmentVariables
GITHUB_CLIENT_ID
???
GITHUB_CLIENT_SECRET
???
APP_ADMIN_PASSWORD
???
KeepAlive
Label
???
ProgramArguments
???/App
--workdir=???
--port=???
RunAtLoad
StandardErrorPath
???
StandardOutPath
???
WorkingDirectory
???
```