Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dcmorse committed Jun 26, 2018
1 parent 02477f6 commit b95a5ca
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# README


## ContraDB

This is an online database for managing contra dances. The intended
Expand All @@ -15,24 +14,25 @@ This library is released under the AGPL, see COPYING for details.

## Development

Well, you'll need some proficiency in Ruby. Check the Gemfile.lock for
the relevant versions. I use rvm to manage gems.
Contact us for help. But if you don't wanna, here's some information:
Check the Gemfile.lock for the relevant versions of Ruby. I use rbenv
to manage gems.

Database configuration is pretty simple and should be handled by
migrations. Creating a Postgres user is [handled in the wiki](https://github.com/contradb/contra/wiki/Setting-up-Postgres-for-Development-and-Testing).
After the database is created and migrated, there are two manual
things (which really should be in a script, even before tests, but I don't know how to do that):
If you've come this far, maybe it's time to contact the project for a db replica so you can test against real data, but if you want to create your own empty DB:

1. run `rake db:seed` to create the special choreographer 'Unknown'
2. The first user you create through the website has super special
powers, so go ahead and create her. I like the username 'admonsterator'.
powers.

## Deployment

[Deployment instructions](https://github.com/contradb/contra/wiki/Installing-new-git-version-onto-production-server) are in the wiki.

## Testing

bin/rake spec

```
bundle exec rspec
```
will run all tests.

0 comments on commit b95a5ca

Please sign in to comment.