updated readme

This commit is contained in:
nilsding 2015-04-02 01:14:54 +02:00
parent 64405b32ff
commit 7236a8c46f

View file

@ -1,4 +1,7 @@
# justask
# justask (aka. the software behind Retrospring)
This is the source code that powered Retrospring. Yep, all of it. Including
all the branches where we left off.
## Requirements
@ -6,12 +9,26 @@
- Ruby 2.0.0+
- Bundler
- PostgreSQL
- Redis
- Redis (for Sidekiq)
- ImageMagick (for image processing)
## Installation (production)
We've installed justask on FreeBSD 10 using rvm. What we also did was
creating a new, seperate user just for justask to run in. On FreeBSD, this
is done with:
# pw user add justask
### Database
At Retrospring, we were using PostgreSQL as the database backend. The
software might work on MySQL too, but that was not tested.
Installation from Ports (using `portmaster`):
# portmaster databases/postgresql93-server
#### PostgreSQL
$ sudo -u postgres psql -d template1
@ -23,11 +40,16 @@ Try connecting to the database:
$ psql -U justask -d justask_production
### nginx
See [docs/nginx.conf](https://github.com/nilsding/justask/blob/master/docs/nginx.conf)
for the configuration we used on Retrospring.
### justask
#### Clone the Source
$ git clone https://git.rrerr.net/nilsding/justask.git justask
$ git clone https://github.com/nilsding/justask.git justask
#### Configure It
@ -72,7 +94,7 @@ Try connecting to the database:
# Development mode:
$ bundle exec rails server
Create an account on your justask installation.
Now, create an account on your justask installation.
To make yourself an admin, just execute:
@ -82,12 +104,12 @@ If you want to remove admin status from a certain user, you can do this:
$ bundle exec rake 'justask:deadmin[get_rekt]' RAILS_ENV=production
Add/remove moderators:
Add/remove moderators (this can be done via the web interface by visiting an user as an admin):
$ bundle exec rake 'justask:mod[someone_else]' RAILS_ENV=production
$ bundle exec rake 'justask:demod[someone_else]' RAILS_ENV=production
Add/remove supporters:
Add/remove supporters (this can be done via the web interface by visiting an user as an admin/mod):
$ bundle exec rake 'justask:sup[someone_else]' RAILS_ENV=production
$ bundle exec rake 'justask:desup[someone_else]' RAILS_ENV=production
@ -95,3 +117,14 @@ Add/remove supporters:
Export user data:
$ bundle exec rake 'justask:export[jdoe@example.tld]' RAILS_ENV=production
Find the user(s) with the most self-asked anonymous questions:
$ bundle exec rake justask:loners
## The Official Retrospring Closedown Soundtrack™
* [Scooter - Can't Stop The Hardcore](https://www.youtube.com/watch?v=nJ3bet-Y79w)
* [Darude - Sandstorm](https://www.youtube.com/watch?v=y6120QOlsfU)
* [Max Raabe - Oops I Did It Again](https://www.youtube.com/watch?v=qYr9kIyambE)