Contents

# Tramway::Event
Short description and motivation.

## Usage
How to use my plugin.

## Installation

#### 1. Add this line to your application's Gemfile:

```ruby
gem 'tramway-event'
gem 'carrierwave'
gem 'more_html_tags'
gem 'configus'
```

#### 2. And then execute:
```bash
$ bundle
```

#### 3. Then run:
```shell
rails g tramway:event:install
rails db:migrate
```

#### 4. Then make `tramway-landing` installation. [How-to](https://github.com/ulmic/tramway-dev/blob/develop/tramway-landing/README.md#installation)

Versions table

| tramway-event | tramway-landing |
| ------------- | --------------- |
| < 1.9.27.1 | 1.x |
| >= 1.9.27.2 | 2.x | 

#### 5. Add events to admin panel

*config/initializers/tramway.rb*
```ruby
Tramway.set_available_models ::Tramway::Event::Event, ::Tramway::Event::ParticipantFormField, ::Tramway::Event::Participant, project: #{project_which_you_used_in_the_application}
```

#### 6. Add events routes to the app

*config/routes.rb*
```ruby
mount Tramway::Event::Engine, at: '/'
```

#### 7. Add hosts in your environments via gem `configus`. [What is configus?](https://github.com/kaize/configus)

*config/configus.rb*
```ruby
Configus.build Rails.env do
  env :production do
    host 'https://your-site-domain.com'
  end
  env :development do
    host 'http://localhost:3000'
  end
  env :test, parent: :development
end
```

## How-to

### Create event

English docs coming soon...
[На русском](https://github.com/ulmic/tramway-dev/tree/develop/tramway-event/docs/russian)

## Contributing
Contribution directions go here.

## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
tramway-event-2.0.1	README.md
tramway-event-2.0.0.1	README.md
tramway-event-2.0	README.md