https://github.com/OpenHunting/openhunt

discover new products, give feedback, help each other
https://github.com/OpenHunting/openhunt

Last synced: 3 months ago
JSON representation

discover new products, give feedback, help each other

• Host: GitHub
• URL: https://github.com/OpenHunting/openhunt
• Owner: OpenHunting
• License: mit
• Created: 2015-12-17T22:57:32.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-08T16:42:39.000Z (almost 9 years ago)
• Last Synced: 2024-02-11T15:55:41.212Z (9 months ago)
• Language: Ruby
• Homepage:
• Size: 2.32 MB
• Stars: 413
• Watchers: 16
• Forks: 52
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Open Hunt

[![Join the chat at https://gitter.im/OpenHunting/openhunt](https://badges.gitter.im/OpenHunting/openhunt.svg)](https://gitter.im/OpenHunting/openhunt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Open Hunt is a brand new community for fans and builders of early stage technology products. We aim to be completely open and transparent, without insiders or gatekeepers who control who gets listed and who gets left out.

## Dependencies

* Ruby on Rails (Rails 4.2.5 on Ruby 2.1.4) [install](http://railsapps.github.io/installrubyonrails-mac.html)

* PostgreSQL [install on mac](http://postgresapp.com/) | [install on linux](https://wiki.postgresql.org/wiki/Detailed_installation_guides)

## Development

Firstly, fork the repo on the master branch and clone your repo

`git clone https://github.com//openhunt`

Install the required gems with bundler

`bundle install`

Create a new branch for your feature

`git checkout -b feature/your-feature`

Setup the Twitter App [instructions](#Setup-Your-Twitter-App)

Run the application using

`rails server`

When you have finished your feature and added your tests, [submit a pull request](https://github.com/OpenHunting/openhunt/compare) using your feature branch.

## Setup Your Twitter App

Open Hunt currently uses Twitter authentication. To dev locally, you'll need to create an app on Twitter.com and use the auth keys they provide you.

1) Create a dev app with your twitter account: https://apps.twitter.com/app/new

  * set the name to something unique (something like "Open Hunt dev - [your github username]")

  * set description / website to anything

  * set the callback url to http://goo.gl/QVYCy (a shortlink that points to http://localhost:3000/auth/twitter/callback)

  * example: ![](http://cl.ly/3W3P0u0j3q1A/content)

2) Change the permissions to "Read Only"

  * in "Application Settings -> Access Level", click "modify app permissions"

    ![](http://cl.ly/2I0D0e1R0c0d/content)

  * http://cl.ly/1o2J203N3l3M

3) Click on the tab "Keys and Access Tokens". Then create a new file at `config/settings.local.yml` with the content:

```

# pull the value for "Consumer Key (API Key)"

twitter_key: "PASTE_REAL_KEY_HERE"

# pull the value for "Consumer Secret (API Secret)"

twitter_secret: "PASTE_REAL_SECRET_HERE"

```

## Override Database configuration on development

Configure an ENV variable locally for `DATABASE_URL`. Configuration instructions [here.](http://edgeguides.rubyonrails.org/configuring.html#configuring-a-database)

    postgresql://localhost/myopenhunt

## Getting Sample data

In dev mode it's useful to generate a randomly generated list of users, posts, and votes.

    rake db:seed

## Dev Login

In dev mode, it's useful to be able to log in as any user. To do this, navigate to: http://locahost:3000/devauth

## License

Open Hunt is released under the MIT License.