Skip to content

jmalcic/spina-admin-mail

Repository files navigation

Mail

Build Status Maintainability Test Coverage

Mail is a plugin for Spina (a Rails content management system) to add email functionality.

Usage

The plugin will add an Email item to Spina's primary navigation menu.

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-mail', github: 'jmalcic/spina-admin-mail'

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_mail:install:migrations
$ rake db:migrate

Configuring the main Rails app

Conferences requires a job queueing backend for import functionality. Read about this in the Rails guide covering Active Job.

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.