Skip to content

Commit

Permalink
Wording, license and stuffs 🤘
Browse files Browse the repository at this point in the history
  • Loading branch information
damienalexandre committed Nov 12, 2015
1 parent 65dbf78 commit 0367785
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 9 deletions.
19 changes: 19 additions & 0 deletions LICENSE
@@ -0,0 +1,19 @@
Copyright (c) 2015 JoliCode

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
19 changes: 10 additions & 9 deletions README.md
Expand Up @@ -2,23 +2,25 @@

Just go to https://slack-secret-santa.herokuapp.com/ and have fun.

<!--<a href="https://slack.com/oauth/authorize?scope=commands&client_id=2167807910.14252538375"><img
alt="Add to Slack" height="40" width="139" src="https://platform.slack-edge.com/img/add_to_slack.png"
srcset="https://platform.slack-edge.com/img/add_to_slack.png 1x, https://platform.slack-edge.com/img/add_to_slack@2x.png 2x"></a>-->
Code source is under MIT License.

## Install
- This application is powered by Symfony 2.8 and his new Micro Kernel;
- Hosting is provided by Heroku;
- Session are stored in Heroku Redis servers;
- Frontend is built with bootstrap, obviously (any help welcome from designer ^^);
- For now, the calls to "ChatPostMessage" Slack API are done procedurally, this may be hard on the API / PHP / Heroku for big Secret Santa... Let us know!
- Built with ♥ by @pyrech and @damienalexandre.

- Download and install the Heroku Toolbelt or learn more about the Heroku Command Line Interface.
## Install, run and deploy

- Download and install the Heroku Toolbelt
- If you haven't already, log in to your Heroku account and follow the prompts to create a new SSH public key.
- Give your heroku details to Damien to be able to deploy


$ heroku login
$ heroku git:remote -a slack-secret-santa
$ heroku plugins:install heroku-redis
$ git push heroku master

## Run the project

The app require:

Expand All @@ -34,4 +36,3 @@ Variables are:
- SLACK_CLIENT_SECRET: Application secret from Slack;
- SLACK_CLIENT_ID: Application id from Slack;
- REDIS_URL: The full redis connexion url (default `redis://localhost:6379`)

0 comments on commit 0367785

Please sign in to comment.