Skip to content

Commit 7e82025

Browse files
committed
Give this thing a proper README
1 parent 9d25e16 commit 7e82025

File tree

2 files changed

+52
-11
lines changed

2 files changed

+52
-11
lines changed

README.md

+52-11
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,51 @@
1-
# eurucamp Activities [2013+]
1+
# eurucamp Activities
2+
3+
The eurucamp activities app is a small application to allow attendees to organize and plan small event in and around a conference. Users create events or sign up to created ones. Signup works through Github or Twitter.
4+
5+
The app is mobile friendly and easy to run on a free Heroku account.
6+
7+
## Donationware
8+
9+
The app was created by members on the Ruby Berlin e.V. on their free time as a community effort for the eurucamp conference. Ruby Berlin is the body behind RailsGirls Berlin and Hamburg, eurucamp and JRubyConf.eu.
10+
11+
If you end up using the app, please get in [contact](mailto:[email protected]) so that we know. Also, spread the word about our [projects](http://rubyberlin.org). Also, consider [donating](https://www.betterplace.org/en/organisations/ruby-berlin/), especially, if you run a commercial conference. We are a registered non-profit, donations are tax deducible. Betterplace handles all paperwork - if in doubt, send us a mail.
12+
13+
If you cannot or don't want to donate - use it, it's free.
14+
15+
## Logo
16+
17+
Don't use the eurucamp logo for your instance to avoid confusion.
18+
19+
## Examples
20+
21+
An instance of the app can be seen running at the [eurucamp activities page](http://activities.eurucamp.org).
22+
23+
Screenshot: ![The activities app](screenshot.png)
24+
25+
## Running the app on Heroku
26+
27+
Deploying the app is simple:
28+
29+
* Clone this repository: `https://github.com/eurucamp/eurucamp-activities-2013/`
30+
31+
* An account and a created application at Heroku.
32+
* A registered twitter application. Go [here](https://apps.twitter.com/).
33+
* A registered github application. Go [here](https://github.com/settings/applications).
34+
* Add their keys to your Heroku app as described [here](https://devcenter.heroku.com/articles/config-vars).
35+
36+
* Push the repository to Heroku: `git push [email protected]:<name-of-your-app>.git`
37+
38+
### **ENV** variables used:
39+
40+
* `GITHUB_KEY`: Your github application key.
41+
* `GITHUB_SECRET`: Your github application secret.
42+
* `TWITTER_KEY`: Your twitter application key.
43+
* `TWITTER_SECRET`: Your twitter application secret.
244

345
## Development
446

47+
An install postgresql instance and a compiler is needed.
48+
549
### Basic setup
650

751
* `echo 'activities.dev localhost' > /etc/hosts`
@@ -15,22 +59,19 @@
1559

1660
### Customization
1761

18-
*(work in progress)*
62+
Customization is currently work in process, so the way to go is to fork the application.
1963

2064
* Fork it
2165
* edit `config/application.yml`
2266
* edit `app/assets/stylesheets/_settings.sass`
2367

24-
## Deployment
68+
## Authors
2569

26-
### How to deploy app?
70+
This app was created by:
2771

28-
* `bundle exec rake staging deploy`
29-
* `bundle exec rake production deploy`
72+
* [Florian Plank](https://twitter.com/polarblau)
73+
* [Piotr Gęga](https://twitter.com/piotrgega)
3074

31-
### **ENV** variables:
75+
## License
3276

33-
* `GITHUB_KEY`
34-
* `GITHUB_SECRET`
35-
* `TWITTER_KEY`
36-
* `TWITTER_SECRET`
77+
GNU-AGPL-3.0, see COPYRIGHT for details.

screenshot.png

318 KB
Loading

0 commit comments

Comments
 (0)