https://github.com/freshshell/fresh-api

The code behind api.freshshell.com.
https://github.com/freshshell/fresh-api

Last synced: 3 months ago
JSON representation

The code behind api.freshshell.com.

• Host: GitHub
• URL: https://github.com/freshshell/fresh-api
• Owner: freshshell
• Created: 2012-11-30T23:09:48.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2025-05-09T01:22:02.000Z (about 1 year ago)
• Last Synced: 2025-05-19T15:11:39.417Z (about 1 year ago)
• Language: Ruby
• Homepage: http://freshshell.com
• Size: 69.3 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# fresh API

Powers `fresh search`.

## API

### GET /directory

Returns the entire [directory]:

  

- `200` responds with a plain text list of fresh lines

### GET /directory?q=:query

Search the [directory] for `query`:

  

- `200` responds with a plain text list of fresh lines matching `query`

- `500` something went wrong

## Development

To run the app locally:

```

memcached # start memcached

rackup

```

# License

MIT

[directory]: https://github.com/freshshell/fresh/wiki/Directory