This is the source code for contradb.com, an online database for managing contra dances. The intended users are dance callers, dance choreographers, and opinionated dancers. Users create, edit, update, and delete dances, as well as copying and viewing other users' dances. Users can create programs of dances and call them from their phone or print outs.
This library is released under the AGPL, see COPYING for details.
See terraform/README.md for details on installing contradb in the cloud with Terraform and Amazon Web Services.
In terminal one:
bin/rails s
And optionally in terminal two:
bin/webpack-dev-server
But how do I get configured? Contact us for help. Getting contradb running locally is a 397-step process that is not easy unless you have a good understanding of ruby, javascript, postgres, and your operating-system of choice. But if you don't wanna contact us, here's some notes on how to do it, current at time of writing, but probably outdated by the time you read this.
Install rbenv to manage versions of ruby https://github.com/rbenv/rbenv
rbenv install $(cat .ruby-version)
I had to also do sudo apt install gcc make to get a C compiler and the make build tool. Apt is a package manager similar to brew.
I had to run sudo apt install g++ for a C++ compiler.
Then I errored out for lack of postgres, so I did a detour:
For my OS I followed https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04 , basically:
sudo apt install postgresql postgresql-contrib
Then I had to also install libpq-dev for whatever reason.
Okay, I had to go install yarn to get this to work, then run yarn install --check-files.
Database configuration is pretty simple and should be handled by migrations. Creating a Postgres user is handled in the wiki. 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:
- run
rake db:seedto create the special choreographer 'Unknown' - The first user you create through the website has super special powers.
I needed to install chromedriver, which was a binary I downloaded and plopped in /usr/local/bin.
Then in a secret undocumented step that nobody tells you about, you have to also install google-chrome, supposedly at the same version (86 here).
I also did rake db:seed test, but that screwed things up by creating Chorographer 'unknown'. I had to go in and destroy them manually.
Libfigure is the js code that understands contra figures. It runs both on the client side for React, and on the server side for server-side rendering. Because the js environment on the server side (maybe especially in the testing environments) the js is written in an archaic dialect of es5.
To change things correctly edit the code that lives in app/javascript. Then run bin/rake libfigure:compile to copy the code into asset pipeline.
Deployment instructions are in the wiki.
bin/rspec
will run lots of ruby tests.
yarn test
will run a few js tests.
yarn eslint app/javascript/dance-table.tsx
will run the js linter on app/javascript/dance-table.tsx. This is currently the only file that is even remotely lintable.
bin/webpack-dev-server
This will indirectly run the typescript compiler in watch mode - for some reason ts compile errors don't stop the ruby, so I keep an eye on this terminal.