Skip to content

jmalcic/spina-admin-conferences

Repository files navigation

Conferences

Rails tests Coverage Status Total alerts Language grade: JavaScript Code quality Inline docs Visual testing

Conferences is a plugin for Spina (a Rails content management system) to add conference management functionality. With the plugin, you'll be able to manage details of conferences, delegates, and presentations. See the wiki for details of the types of data supported.

Usage

The plugin will add a Conferences item to Spina's primary navigation menu. The menu structure will then be as follows:

  • Other menu items

  • Conferences

    • Institutions

    • Conferences

    • Delegates

    • Presentations

After installing the plugin, you just need to start your server in the usual way:

$ rails s

Installation

From scratch

You'll need Rails installed if it isn't already. Read how to do this in the Rails getting started guide.

Then run:

$ rails new your_app --database postgresql
$ rails db:create
$ rails active_storage:install

Add this line to your application's Gemfile:

gem 'spina'

And then execute:

$ bundle:install

Run the Spina install generator:

$ rails g spina:install

And follow the prompts. Then follow the instructions below.

For existing Spina installations

Add this line to your application's Gemfile:

gem 'spina-admin-conferences'

You'll then need to install and run the migrations from Conferences (the Spina install generator does this for Spina).

First install the migrations and then migrate the database:

$ rake spina_admin_conferences:install:migrations
$ rake db:migrate

Configuring the main Rails app

Conferences requires a job queueing backend for import functionality, and you'll also want to cache pages listing presentations, conferences, and so on. Read about this in the Rails guides covering Active Job and caching.

Contributing

You're very welcome to contribute, particularly to translations. If there's a bug, or you have a feature request, make an issue on GitHub first.

License

The gem is available as open source under the terms of the MIT License.