Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/michalzalecki/social_hussars


https://github.com/michalzalecki/social_hussars

Last synced: 28 days ago
JSON representation

Awesome Lists containing this project

README

        

== SocialHussars

Inspired by {Monterail}[http://monterail.com/] {challenge application}[https://github.com/hussar-academy/challenge_app].

=== Additional Features

There is coupe additional features which weren't mentioned in the challenge
app requirements:

* I18n (with saving locale in session in case logging in through OmniAuth)
* Uploading images to AWS S3
* Sending emails through SendGrid (in the background as it was mensioned using Resque)
* App is running on Heroku: https://social-hussars.herokuapp.com
* Over 120 tests in RSpec

=== Setting up

In order to set up an app you have to provide **.env** file to keep your
environment variables.

Required variables:
* S3_BUCKET_NAME
* S3_HOST_NAME
* AWS_ACCESS_KEY_ID
* AWS_SECRET_ACCESS_KEY
* OMNIAUTH_GITHUB_ID
* OMNIAUTH_GITHUB_SECRET

Optional variables:
* REDISCLOUD_URL (you need redis-server installed localy)

Development-only variables:
* GMAIL_USER
* GMAIL_PASS

=== TODOs

* Save question/answer or user locale in order to send email to the author
in his language (now English only)
* Write more integration tests with Cucumber