Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neilgupta/meowmeowbeenz-api

API for powering MeowMeowBeenz, the ultimate social app!
https://github.com/neilgupta/meowmeowbeenz-api

Last synced: about 1 month ago
JSON representation

API for powering MeowMeowBeenz, the ultimate social app!

Host: GitHub
URL: https://github.com/neilgupta/meowmeowbeenz-api
Owner: neilgupta
License: mit
Created: 2014-03-09T03:00:17.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2014-03-17T01:56:06.000Z (almost 11 years ago)
Last Synced: 2023-03-14T18:10:27.554Z (almost 2 years ago)
Language: Ruby
Homepage:
Size: 318 KB
Stars: 4
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

meowmeowbeenz-api
=============

http://github.com/neilgupta/meowmeowbeenz-api

MeowMeowBeenz let's you say how much you like, who you like, when you like, all from a standard non-Boost Mobile phone!

This project provides a restful API for powering the meowmeowbeenz mobile app.

## Demo

You can test out a demo of the API and read the docs at http://meowmeowbeenz.herokuapp.com

This is running on Heroku's free tier, so it will be slow. Do NOT use this for development. Once you've tested the API out, you should clone this project and run it locally (see Getting Started).

## Progress

So far, this api handles signing up, logging in, rating, and searching users.

## TODO

The following features still need to be added:

* Send push notifications to mobile devices when they are given meowmeowbeenz or when their meowmeowbeenz level changes. I am thinking of using Amazon SNS ([with j7w1 gem](https://github.com/condor/j7w1)) for push notifications.
* Add news feed functionality (see discussions on [r/meowmeowbeenz](http://www.reddit.com/r/Meowmeowbeenz/))

If there are any features that should be added to this list, create a [new issue](https://github.com/neilgupta/meowmeowbeenz-api/issues).

## Getting Started

1. Make sure you have Ruby 2 and Postgres 9 installed (`ruby -v && postgres --version`)
2. Clone this repo (`git clone [email protected]:neilgupta/meowmeowbeenz-api.git`)
3. Copy `config/database.yml.sample`, enter your db username and password, and save as `config/database.yml`
4. Copy `env.sample`, fill out config variables, and save as `.env`
5. Run the following commands:

```ruby
bundle install
rake db:create
rake db:migrate
foreman start -p 3000
```

Access the documentation at http://localhost:3000/docs and the API at http://localhost:3000/

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Make sure all tests pass (`rake test`)
6. Create new Pull Request

## Credits

The idea comes from NBC's *Community* Season 5, Episode 8: "[App Development and Condiments](http://en.wikipedia.org/wiki/App_Development_and_Condiments)"

It is a brilliant episode, check it out!

## Author

Neil Gupta [http://metamorphium.com](http://metamorphium.com)

## License