https://github.com/ojii/githug

Give hugs!
https://github.com/ojii/githug

Last synced: 8 days ago
JSON representation

Give hugs!

• Host: GitHub
• URL: https://github.com/ojii/githug
• Owner: ojii
• License: other
• Created: 2012-07-25T17:17:41.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-08-10T15:57:54.000Z (over 12 years ago)
• Last Synced: 2024-05-01T20:07:38.657Z (7 months ago)
• Language: JavaScript
• Homepage: https://www.githugs.org
• Size: 351 KB
• Stars: 5
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
######

GitHug

######

Run the web server

==================

Make a GitHub app at https://github.com/settings/applications pointing the URL to ``http://localhost:5000/`` and the

callback URL to ``http://localhost:5000/auth/github/``.

Install and run a MongoDB server (I suggest locally,but not necessarily).

Optionally, a pusher.com account.

Make a file called ``.env`` and set the following values:

 * ``GITHUB_SECRET``: Secret of your GitHub app.

 * ``GITHUB_CLIENT_ID``: Client ID of your GitHub app.

 * ``MONGOLAB_URI``: URI to your MongoDB server. Format: ``mongodb://:@:/``. For

   example: ``mongodb://localhost/githug``.

 * ``SECRET``: The secret key. Set it to something, then don't change it.

 * ``LOCAL=True``: For debug mode.

 * ``PUSHER_APP_ID``, ``PUSHER_KEY`` and ``PUSHER_SECRET``: Set to you pusher.com API credentials (optional).

Create a virtualenv.

Activate it.

Install requirements: ``pip install -r requirements.txt``.

Run ``foreman start``.

Open the page at ``http://localhost:5000``.

Enjoy.

**NEVER** commit your ``.env`` file!